ApiResponseL3OrderBook Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseL3OrderBook",
  "type": "object",
  "required": [
    "data",
    "meta",
    "success"
  ],
  "properties": {
    "data": {
      "description": "Current or historical Lighter L3 orderbook snapshot.",
      "type": "object",
      "required": [
        "ask_count",
        "bid_count",
        "coin",
        "mid_price",
        "orders",
        "spread",
        "spread_bps",
        "timestamp",
        "total_ask_size",
        "total_bid_size",
        "truncated"
      ],
      "properties": {
        "ask_count": {
          "description": "Ask order count for the stored checkpoint view.",
          "type": "integer",
          "example": 250
        },
        "bid_count": {
          "description": "Bid order count for the stored checkpoint view.",
          "type": "integer",
          "example": 250
        },
        "coin": {
          "description": "Lighter trading pair symbol.",
          "type": "string",
          "example": "BTC"
        },
        "mid_price": {
          "description": "Mid price as a decimal string when both sides are present; null otherwise.",
          "type": "string",
          "nullable": true,
          "example": "65127.25"
        },
        "orders": {
          "description": "Individual resting orders in the served L3 view.",
          "type": "array",
          "items": {
            "description": "Individual resting order in a Lighter L3 snapshot.",
            "type": "object",
            "required": [
              "order_index",
              "original_size",
              "owner_account_index",
              "price",
              "remaining_size",
              "side"
            ],
            "properties": {
              "order_index": {
                "description": "Numeric order index assigned by Lighter.",
                "type": "integer",
                "format": "int64",
                "example": 562953074779869
              },
              "original_size": {
                "description": "Original venue-native order size.",
                "type": "number",
                "example": 0.02303
              },
              "owner_account_index": {
                "description": "Numeric Lighter account index associated with the resting order.",
                "type": "integer",
                "format": "int64",
                "example": 281474976710654
              },
              "price": {
                "description": "Lighter venue-native resting order price.",
                "type": "number",
                "example": 65127.5
              },
              "remaining_size": {
                "description": "Remaining venue-native order size.",
                "type": "number",
                "example": 0.02303
              },
              "side": {
                "description": "Book side.",
                "type": "string",
                "enum": [
                  "bid",
                  "ask"
                ],
                "example": "bid"
              }
            }
          }
        },
        "spread": {
          "description": "Absolute spread as a decimal string when both sides are present; null otherwise.",
          "type": "string",
          "nullable": true,
          "example": "0.50"
        },
        "spread_bps": {
          "description": "Spread in basis points as a decimal string when both sides are present; null otherwise.",
          "type": "string",
          "nullable": true,
          "example": "0.08"
        },
        "timestamp": {
          "description": "Snapshot timestamp in UTC.",
          "type": "string",
          "format": "date-time",
          "example": "2026-03-12T00:00:00.000Z"
        },
        "total_ask_size": {
          "description": "Aggregate remaining venue-native size across asks.",
          "type": "number",
          "example": 98.76
        },
        "total_bid_size": {
          "description": "Aggregate remaining venue-native size across bids.",
          "type": "number",
          "example": 102.34
        },
        "truncated": {
          "description": "True when the stored checkpoint reached the 250-orders-per-side ingestion cap.",
          "type": "boolean",
          "example": true
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "has_more": {
          "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
          "type": "boolean"
        },
        "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
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "symbol": {
          "description": "Present on per-symbol routes: the symbol the response covers.",
          "type": "string"
        },
        "venue": {
          "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
          "type": "string"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}