OANDA · Schema

ClientPrice

The specification of an Account-specific Price.

ForexFX TradingCFD TradingFinancial ServicesTrading APIs

Properties

Name Type Description
type string The string "PRICE". Used to identify the a Price object when found in a stream.
instrument string The Price's Instrument.
time string The date/time when the Price was created
status string The status of the Price.
tradeable boolean Flag indicating if the Price is tradeable or not
bids array The list of prices and liquidity available on the Instrument's bid side. It is possible for this list to be empty if there is no bid liquidity currently available for the Instrument in the Account.
asks array The list of prices and liquidity available on the Instrument's ask side. It is possible for this list to be empty if there is no ask liquidity currently available for the Instrument in the Account.
closeoutBid string The closeout bid Price. This Price is used when a bid is required to closeout a Position (margin closeout or manual) yet there is no bid liquidity. The closeout bid is never used to open a new positio
closeoutAsk string The closeout ask Price. This Price is used when a ask is required to closeout a Position (margin closeout or manual) yet there is no ask liquidity. The closeout ask is never used to open a new positio
quoteHomeConversionFactors object
unitsAvailable object
View JSON Schema on GitHub

JSON Schema

ClientPrice.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ClientPrice",
  "description": "The specification of an Account-specific Price.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The string \"PRICE\". Used to identify the a Price object when found in a stream."
    },
    "instrument": {
      "type": "string",
      "description": "The Price's Instrument.",
      "format": "A string containing the base currency and quote currency delimited by a \"_\"."
    },
    "time": {
      "type": "string",
      "description": "The date/time when the Price was created",
      "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)."
    },
    "status": {
      "type": "string",
      "description": "The status of the Price.",
      "enum": [
        "tradeable",
        "non-tradeable",
        "invalid"
      ]
    },
    "tradeable": {
      "type": "boolean",
      "description": "Flag indicating if the Price is tradeable or not"
    },
    "bids": {
      "type": "array",
      "description": "The list of prices and liquidity available on the Instrument's bid side. It is possible for this list to be empty if there is no bid liquidity currently available for the Instrument in the Account.",
      "items": {
        "$ref": "#/definitions/PriceBucket"
      }
    },
    "asks": {
      "type": "array",
      "description": "The list of prices and liquidity available on the Instrument's ask side. It is possible for this list to be empty if there is no ask liquidity currently available for the Instrument in the Account.",
      "items": {
        "$ref": "#/definitions/PriceBucket"
      }
    },
    "closeoutBid": {
      "type": "string",
      "description": "The closeout bid Price. This Price is used when a bid is required to closeout a Position (margin closeout or manual) yet there is no bid liquidity. The closeout bid is never used to open a new position.",
      "format": "A decimal number encodes as a string. The amount of precision provided depends on the Instrument."
    },
    "closeoutAsk": {
      "type": "string",
      "description": "The closeout ask Price. This Price is used when a ask is required to closeout a Position (margin closeout or manual) yet there is no ask liquidity. The closeout ask is never used to open a new position.",
      "format": "A decimal number encodes as a string. The amount of precision provided depends on the Instrument."
    },
    "quoteHomeConversionFactors": {
      "$ref": "#/definitions/QuoteHomeConversionFactors"
    },
    "unitsAvailable": {
      "$ref": "#/definitions/UnitsAvailable"
    }
  }
}