TradersPost WebhookMessage Library - Automatically Build JSON

2024年5月15日

Library "WebhookMessageLibrary"
The webhook message library provides several functions for building JSON payloads

method buildWebhookJson(msg, constants)
  Builds the final JSON payload from a webhookMessage type.
  Namespace types: webhookMessage
  Parameters:
    msg (webhookMessage): (webhookMessage) A prepared webhookMessage.
    constants (CONSTANTS)
  Returns: <string> A JSON Payload.

method buildTakeProfitJson(msg)
  Builds the takeProfit JSON message to be used in a webhook message.
  Namespace types: takeProfitMessage
  Parameters:
    msg (takeProfitMessage): (takeProfitMessage)
  Returns: <string> A JSON takeProfit payload.

method buildStopLossJson(msg, constants)
  Builds the stopLoss JSON message to be used in a webhook message.
  Namespace types: stopLossMessage
  Parameters:
    msg (stopLossMessage): (stopLossMessage)
    constants (CONSTANTS)
  Returns: <string> A JSON stopLoss payload.

CONSTANTS
  Constants for payload values.
  Fields:
    ACTION_BUY (series string)
    ACTION_SELL (series string)
    ACTION_EXIT (series string)
    ACTION_CANCEL (series string)
    ACTION_ADD (series string)
    SENTIMENT_BULLISH (series string)
    SENTIMENT_BEARISH (series string)
    SENTIMENT_LONG (series string)
    SENTIMENT_SHORT (series string)
    SENTIMENT_FLAT (series string)
    STOP_LOSS_TYPE_STOP (series string)
    STOP_LOSS_TYPE_STOP_LIMIT (series string)
    STOP_LOSS_TYPE_TRAILING_STOP (series string)

webhookMessage
  Final webhook message.
  Fields:
    ticker (series string)
    action (series string)
    sentiment (series string)
    price (series float)
    quantity (series int)
    takeProfit (series string)
    stopLoss (series string)

takeProfitMessage
  Take profit message.
  Fields:
    limitPrice (series float)
    percent (series float)
    amount (series float)

stopLossMessage
  Stop loss message.
  Fields:
    type (series string)
    percent (series float)
    amount (series float)
    stopPrice (series float)
    limitPrice (series float)
    trailPrice (series float)
    trailPercent (series float)

2024年5月23日

リリースノート

v2
- Changed the

timestamp

property to

time

that will display the time in default ISO 8601 format.