Get Lighter L3 orderbook history JSON Schema

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas. Get historical Lighter L3 order-level snapshots with price, remaining size, order_index, and owner_account_index. The public checkpoint-history response is an array of snapshots; each snapshot returns up to 250 resting orders per side. Optional granularity selects checkpoint, 30s, 10s, 1s, or tick resolution (checkpoint default); optional account filters by numeric account index. Data available from March 2026.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/lighter/l3orderbook/{symbol}/history`
operationId	`getLighterL3OrderbookHistory`
Tag	Lighter - L3 Order Book
Family	Lighter
Deprecated or legacy	no

Human endpoint reference

Open GET /v1/lighter/l3orderbook/{symbol}/history for authentication, parameters, responses, and examples.

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol (e.g., BTC, ETH, SOL)",
      "type": "string",
      "example": "BTC",
      "x-parameter-location": "path"
    }
  }
}

Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp in Unix milliseconds. Defaults to 24 hours before the request. ISO 8601 strings are rejected.",
      "type": "integer",
      "format": "int64",
      "example": 1773273600000,
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp in Unix milliseconds. Defaults to now. ISO 8601 strings are rejected.",
      "type": "integer",
      "format": "int64",
      "example": 1773273900000,
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Timestamp cursor in Unix milliseconds from the previous response metadata.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of snapshots per response; effective values are clamped to 1–1000 (default: 100).",
      "type": "integer",
      "format": "int64",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "granularity": {
      "description": "Optional history resolution. Canonical values are checkpoint (default), 30s, 10s, 1s, and tick.",
      "type": "string",
      "enum": [
        "checkpoint",
        "30s",
        "10s",
        "1s",
        "tick"
      ],
      "default": "checkpoint",
      "x-parameter-location": "query"
    },
    "account": {
      "description": "Optional numeric Lighter account index filter.",
      "type": "integer",
      "format": "int64",
      "example": 281474976710654,
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

Typed historical L3 orderbook snapshot array

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory response 200",
  "type": "object",
  "required": [
    "data",
    "meta",
    "success"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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
    }
  }
}

Status 400

Invalid request

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "param": "limit",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
  "success": false
}

Status 401

Authentication required

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}

Status 429

Rate limit exceeded

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getLighterL3OrderbookHistory response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

{
  "code": 429,
  "error": "Rate limit exceeded"
}

Endpoint reference

Requests and responses

Datasets

Venues

OpenAPI and schemas

Guides

Get Lighter L3 orderbook history JSON Schema

Route Metadata

Human endpoint reference

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

OpenAPI example

Status 401

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Human endpoint reference

​Request Parameters

​Path Parameters

​Query Parameters

​Response Contracts

​Status 200

​application/json

​Status 400

​application/json

OpenAPI example

​Status 401

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Human endpoint reference

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 429

application/json