ApiResponseOpenInterest Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseOpenInterest",
  "type": "object",
  "properties": {
    "data": {
      "description": "Open interest snapshot with market context",
      "type": "object",
      "required": [
        "coin",
        "open_interest",
        "symbol",
        "timestamp"
      ],
      "properties": {
        "coin": {
          "description": "Trading pair symbol (deprecated, use symbol instead)",
          "type": "string",
          "deprecated": true,
          "example": "BTC"
        },
        "day_ntl_volume": {
          "description": "24-hour notional volume",
          "type": "string",
          "nullable": true,
          "example": "10000000.00"
        },
        "impact_ask_price": {
          "description": "Impact ask price for liquidations",
          "type": "string",
          "nullable": true
        },
        "impact_bid_price": {
          "description": "Impact bid price for liquidations",
          "type": "string",
          "nullable": true
        },
        "mark_price": {
          "description": "Mark price used for liquidations",
          "type": "string",
          "nullable": true,
          "example": "42500.50"
        },
        "mid_price": {
          "description": "Current mid price",
          "type": "string",
          "nullable": true,
          "example": "42500.75"
        },
        "open_interest": {
          "description": "Total open interest in contracts",
          "type": "string",
          "example": "500000.00"
        },
        "oracle_price": {
          "description": "Oracle price from external feed",
          "type": "string",
          "nullable": true,
          "example": "42498.25"
        },
        "prev_day_price": {
          "description": "Price 24 hours ago",
          "type": "string",
          "nullable": true,
          "example": "42000.00"
        },
        "symbol": {
          "description": "Trading pair symbol",
          "type": "string",
          "example": "BTC"
        },
        "timestamp": {
          "description": "Snapshot timestamp (UTC)",
          "type": "string",
          "format": "date-time",
          "example": "2025-01-21T10:30:00.000Z"
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}