Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/lighter/l3orderbook/{symbol} |
| operationId | getLighterL3Orderbook |
| Tag | Lighter - L3 Order Book |
| Family | Lighter |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterL3Orderbook 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": "getLighterL3Orderbook query parameters",
"type": "object",
"properties": {
"timestamp": {
"description": "Unix timestamp in milliseconds for the requested Lighter snapshot. If omitted, returns the latest snapshot. ISO 8601 strings are rejected.",
"type": "integer",
"format": "int64",
"example": 1773273600000,
"x-parameter-location": "query"
},
"account": {
"description": "Optional numeric Lighter account index filter.",
"type": "integer",
"format": "int64",
"example": 281474976710654,
"x-parameter-location": "query"
},
"depth": {
"description": "Optional maximum number of resting orders returned per side. Values are clamped to the 1–250 ingestion cap.",
"type": "integer",
"format": "int64",
"example": 50,
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
Typed L3 orderbook snapshotapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterL3Orderbook response 200",
"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"
},
"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"
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterL3Orderbook 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"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterL3Orderbook 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"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterL3Orderbook 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"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}