OANDA · Schema

StopLossDetails

StopLossDetails specifies the details of a 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 Stop Loss, or when a Trade's dependent Stop Loss Order is modified directly through the Trade.

ForexFX TradingCFD TradingFinancial-ServicesTrading APIs

Properties

Name Type Description
price string The price that the Stop Loss Order will be triggered at. Only one of the price and distance fields may be specified.
distance string Specifies the distance (in price units) from the Trade's open price to use as the Stop Loss Order price. Only one of the distance and price fields may be specified.
timeInForce string The time in force for the created Stop Loss Order. This may only be GTC, GTD or GFD.
gtdTime string The date when the Stop Loss Order will be cancelled on if timeInForce is GTD.
clientExtensions object
guaranteed boolean Flag indicating that the price for the Stop Loss Order is guaranteed. The default value depends on the GuaranteedStopLossOrderMode of the account, if it is REQUIRED, the default will be true, for DISA
View JSON Schema on GitHub

JSON Schema

StopLossDetails.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StopLossDetails",
  "description": "StopLossDetails specifies the details of a 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 Stop Loss, or when a Trade's dependent Stop Loss Order is modified directly through the Trade.",
  "type": "object",
  "properties": {
    "price": {
      "type": "string",
      "description": "The price that the Stop Loss 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."
    },
    "distance": {
      "type": "string",
      "description": "Specifies the distance (in price units) from the Trade's open price to use as the Stop Loss Order price. Only one of the distance and price fields may be specified.",
      "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 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 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"
    },
    "guaranteed": {
      "type": "boolean",
      "description": "Flag indicating that the price for the Stop Loss Order is guaranteed. The default value depends on the GuaranteedStopLossOrderMode of the account, if it is REQUIRED, the default will be true, for DISABLED or ENABLED the default is false."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/StopLossDetails"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.