total_accounts. Lighter position routes take account indices. Not available on Lighter on Robinhood Chain. Billed at 1 credit per request.
Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/lighter/accounts |
| operationId | getLighterAccountsByL1 |
| Tag | Lighter - Positions |
| Family | Lighter |
| Deprecated or legacy | no |
Request Parameters
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterAccountsByL1 query parameters",
"type": "object",
"required": [
"l1_address"
],
"properties": {
"l1_address": {
"description": "L1 address: 0x followed by 40 hex characters.",
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$",
"x-parameter-location": "query"
},
"limit": {
"description": "Maximum rows per page (default 500, max 5000).",
"type": "integer",
"default": 500,
"minimum": 1,
"maximum": 5000,
"x-parameter-location": "query"
},
"cursor": {
"description": "Cursor from the previous response `meta.next_cursor`. Keep every other parameter unchanged.",
"type": "string",
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
Resolve Lighter accounts by L1 addressapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterAccountsByL1 response 200",
"description": "Lighter accounts owned by an L1 address.",
"type": "object",
"required": [
"data",
"meta",
"success"
],
"properties": {
"data": {
"description": "Lighter mainnet accounts owned by one L1 address.",
"type": "object",
"required": [
"accounts",
"l1_address",
"total_accounts"
],
"properties": {
"accounts": {
"type": "array",
"items": {
"type": "object",
"required": [
"account_index",
"account_type",
"first_seen"
],
"properties": {
"account_index": {
"description": "Lighter account index as a string.",
"type": "string",
"example": "513030"
},
"account_type": {
"description": "Lighter account type as reported by Lighter.",
"type": "integer",
"example": 0
},
"first_seen": {
"description": "First time the account was seen.",
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
},
"l1_address": {
"description": "L1 address, lowercase.",
"type": "string",
"example": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
},
"total_accounts": {
"description": "Number of accounts the address owns (across all pages).",
"type": "integer",
"format": "int64",
"example": 3
}
}
},
"meta": {
"description": "Response metadata of the account positions routes. Every instant is RFC 3339 UTC with milliseconds and comes from the data, never the request time.",
"type": "object",
"required": [
"count",
"request_id"
],
"properties": {
"as_of": {
"description": "Instant the returned state describes: the snapshot tick or hour, or the requested as-of time.",
"type": "string",
"format": "date-time"
},
"built_through": {
"description": "Every event before this instant is built into the change log and as-of state. Reads are clamped to it.",
"type": "string",
"format": "date-time"
},
"clamped_to": {
"description": "Boundary the read was clamped to (`built_through`). Present only when clamped.",
"type": "string",
"format": "date-time"
},
"count": {
"description": "Number of records returned.",
"type": "integer"
},
"coverage_from": {
"description": "Coverage start, present with `notice` when the request falls before coverage or the address has no recorded activity.",
"type": "string",
"format": "date-time"
},
"finalized_through": {
"description": "Every event before this instant is final and will not be re-derived (Lighter: the trade finalization watermark). Never later than `built_through`.",
"type": "string",
"format": "date-time"
},
"next_cursor": {
"description": "Signed cursor for the next page, bound to the request. Pass it back with the same parameters. A market cursor pins its snapshot; if that snapshot is replaced or expires the next page answers 409 `snapshot_advanced`.",
"type": "string",
"nullable": true
},
"notice": {
"description": "Human-readable advisory: before coverage, no recorded activity, or a stale snapshot.",
"type": "string"
},
"quality": {
"description": "Completeness of the snapshot the response was read from: `complete`, `partial`, or `degraded`. Rows carry their own `quality`. On Lighter and Robinhood Chain, snapshots from the latest day, before the venue's daily trade reconcile, can read `degraded` while their rows read `preliminary`; they read `complete` once the reconcile has run.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support.",
"type": "string",
"format": "uuid"
},
"requested_end": {
"description": "The `end` or `timestamp` the caller asked for, echoed when the read was clamped.",
"type": "string",
"format": "date-time"
},
"snapshot_ts": {
"description": "Committed snapshot the response was read from. Market routes echo the resolved `hour` here.",
"type": "string",
"format": "date-time"
},
"source": {
"description": "How the rows were produced: `snapshot` (live or hourly snapshot), `reconstructed` (as-of state between snapshots), or `changes` (change log).",
"type": "string",
"enum": [
"snapshot",
"reconstructed",
"changes"
]
},
"stale": {
"description": "True on current reads when the latest snapshot is older than 12 minutes; paired with `notice`.",
"type": "boolean"
},
"totals": {
"description": "Market listings, first page only: aggregates over the whole filtered result set, not just this page.",
"allOf": [
{
"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"
}
}
}
]
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterAccountsByL1 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": "getLighterAccountsByL1 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": "getLighterAccountsByL1 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"
}
Status 503
Positions, pagination, or an as-of reconstruction are temporarily unavailable (error_code positions_unavailable, pagination_unavailable, or reconstruction_unavailable). Retry shortly.
application/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterAccountsByL1 response 503",
"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": 503,
"error": "Account positions are not available right now.",
"error_code": "positions_unavailable"
}