OANDA · Schema

TakeProfitDetails

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

ForexFX TradingCFD TradingFinancial ServicesTrading APIs

Properties

Name Type Description
price string The price that the Take Profit Order will be triggered at. Only one of the price and distance fields may be specified.
timeInForce string The time in force for the created Take Profit Order. This may only be GTC, GTD or GFD.
gtdTime string The date when the Take Profit Order will be cancelled on if timeInForce is GTD.
clientExtensions object
View JSON Schema on GitHub

JSON Schema

TakeProfitDetails.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TakeProfitDetails",
  "description": "TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Take Profit, or when a Trade's dependent Take Profit Order is modified directly through the Trade.",
  "type": "object",
  "properties": {
    "price": {
      "type": "string",
      "description": "The price that the Take Profit Order will be triggered at. Only one of the price and distance fields may be specified.",
      "format": "A decimal number encodes as a string. The amount of precision provided depends on the Instrument."
    },
    "timeInForce": {
      "type": "string",
      "description": "The time in force for the created Take Profit Order. This may only be GTC, GTD or GFD.",
      "enum": [
        "GTC",
        "GTD",
        "GFD",
        "FOK",
        "IOC"
      ]
    },
    "gtdTime": {
      "type": "string",
      "description": "The date when the Take Profit 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"
    }
  }
}