OANDA · Schema

PositionBookBucket

The position book data for a partition of the instrument's prices.

ForexFX TradingCFD TradingFinancial ServicesTrading APIs

Properties

Name Type Description
price string The lowest price (inclusive) covered by the bucket. The bucket covers the price range from the price to price + the position book's bucketWidth.
longCountPercent string The percentage of the total number of positions represented by the long positions found in this bucket.
shortCountPercent string The percentage of the total number of positions represented by the short positions found in this bucket.
View JSON Schema on GitHub

JSON Schema

PositionBookBucket.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PositionBookBucket",
  "description": "The position book data for a partition of the instrument's prices.",
  "type": "object",
  "properties": {
    "price": {
      "type": "string",
      "description": "The lowest price (inclusive) covered by the bucket. The bucket covers the price range from the price to price + the position book's bucketWidth.",
      "format": "A decimal number encodes as a string. The amount of precision provided depends on the Instrument."
    },
    "longCountPercent": {
      "type": "string",
      "description": "The percentage of the total number of positions represented by the long positions found in this bucket.",
      "format": "A decimal number encoded as a string. The amount of precision provided depends on what the number represents."
    },
    "shortCountPercent": {
      "type": "string",
      "description": "The percentage of the total number of positions represented by the short positions found in this bucket.",
      "format": "A decimal number encoded as a string. The amount of precision provided depends on what the number represents."
    }
  }
}