MarketPositionsSummary Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MarketPositionsSummary",
  "description": "Long and short aggregates of every open position in one market at one snapshot. Averages cover only positions with a known entry (`*_positions_with_entry`). Shares are decimal ratios of the side or total value held by the ten largest positions.",
  "type": "object",
  "required": [
    "coin",
    "long_avg_entry_price",
    "long_count",
    "long_positions_with_entry",
    "long_size",
    "long_top10_value_share",
    "long_value",
    "quality",
    "short_avg_entry_price",
    "short_count",
    "short_positions_with_entry",
    "short_size",
    "short_top10_value_share",
    "short_value",
    "snapshot_ts",
    "symbol",
    "top10_value_share"
  ],
  "properties": {
    "coin": {
      "description": "Alias of `symbol`.",
      "type": "string",
      "example": "BTC"
    },
    "dex": {
      "description": "HIP-3 only.",
      "type": "string",
      "example": "xyz"
    },
    "long_avg_entry_price": {
      "description": "Size-weighted average entry of long positions with a known entry.",
      "type": "string",
      "nullable": true,
      "example": "63120.4"
    },
    "long_count": {
      "type": "integer",
      "format": "int64",
      "example": 18234
    },
    "long_positions_with_entry": {
      "type": "integer",
      "format": "int64",
      "example": 18230
    },
    "long_size": {
      "description": "Total long size in base units.",
      "type": "string",
      "example": "8123.45"
    },
    "long_top10_value_share": {
      "description": "Share of long value held by the ten largest long positions.",
      "type": "string",
      "nullable": true,
      "example": "0.412345"
    },
    "long_value": {
      "description": "Total long value in USD. Null when any long position has no mark.",
      "type": "string",
      "nullable": true,
      "example": "528000000.5"
    },
    "quality": {
      "description": "`complete`, `partial`, or `degraded`, from this market's own rows.",
      "type": "string",
      "example": "complete"
    },
    "short_avg_entry_price": {
      "description": "Size-weighted average entry of short positions with a known entry.",
      "type": "string",
      "nullable": true,
      "example": "66210.9"
    },
    "short_count": {
      "type": "integer",
      "format": "int64",
      "example": 15102
    },
    "short_positions_with_entry": {
      "type": "integer",
      "format": "int64",
      "example": 15100
    },
    "short_size": {
      "description": "Total short size in base units.",
      "type": "string",
      "example": "8120.1"
    },
    "short_top10_value_share": {
      "description": "Share of short value held by the ten largest short positions.",
      "type": "string",
      "nullable": true,
      "example": "0.385"
    },
    "short_value": {
      "description": "Total short value in USD. Null when any short position has no mark.",
      "type": "string",
      "nullable": true,
      "example": "527800000.25"
    },
    "snapshot_ts": {
      "description": "Snapshot the aggregates describe.",
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "symbol": {
      "type": "string",
      "example": "BTC"
    },
    "top10_value_share": {
      "description": "Share of total value held by the ten largest positions.",
      "type": "string",
      "nullable": true,
      "example": "0.301"
    }
  }
}