OANDA · Schema

TrailingStopLossDetails

TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade's dependent Trailing Stop Loss Order is modified directly through the Trade.

ForexFX TradingCFD TradingFinancial ServicesTrading APIs

Properties

Name Type Description
distance string The distance (in price units) from the Trade's fill price that the Trailing Stop Loss Order will be triggered at.
timeInForce string The time in force for the created Trailing Stop Loss Order. This may only be GTC, GTD or GFD.
gtdTime string The date when the Trailing Stop Loss Order will be cancelled on if timeInForce is GTD.
clientExtensions object
View JSON Schema on GitHub

JSON Schema

TrailingStopLossDetails.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TrailingStopLossDetails",
  "description": "TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade's dependent Trailing Stop Loss Order is modified directly through the Trade.",
  "type": "object",
  "properties": {
    "distance": {
      "type": "string",
      "description": "The distance (in price units) from the Trade's fill price that the Trailing Stop Loss Order will be triggered at.",
      "format": "A decimal number encoded as a string. The amount of precision provided depends on what the number represents."
    },
    "timeInForce": {
      "type": "string",
      "description": "The time in force for the created Trailing Stop Loss Order. This may only be GTC, GTD or GFD.",
      "enum": [
        "GTC",
        "GTD",
        "GFD",
        "FOK",
        "IOC"
      ]
    },
    "gtdTime": {
      "type": "string",
      "description": "The date when the Trailing Stop Loss Order will be cancelled on if timeInForce is GTD.",
      "format": "The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places)."
    },
    "clientExtensions": {
      "$ref": "#/definitions/ClientExtensions"
    }
  }
}