Get one holder and its rank
One holder’s balance and rank. The rank is exact when holder_count is at most 100,000; above that it comes from a periodic refresh and rank_as_of says which ledger. Credit class assets-holder: 2 × ceil(rows/100), at least one credit per started 64 KiB. While a large asset’s rank is first computed the answer comes at once with rank null, rank_note and Retry-After, and is not charged. Publishable keys are not allowed.
- Unknown or repeated query parameters return 400, so a typo or an unsupported filter never returns unfiltered data.
Authorizations
Send Authorization: Bearer <key>, the same keys as Activity and RPC. Testnet: lum_test_…; Mainnet: lum_live_…. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable lum_pub_… keys work only on the routes marked "Publishable keys allowed", from an allowed browser origin.
Path Parameters
native, CODE:ISSUER (case-sensitive, never padded), a C… token contract ID or pool:<64 hex>. A Stellar Asset Contract ID is accepted as an alias and resolves to its classic CODE:ISSUER.
"BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX"
Checksum-valid G or C holder address. An M… address resolves to its G account and the response carries muxed_input.
"CCSXXPCXICXOC2MLU3UINWYKL6M5VNLVOTHA4ZQ5S5BEDZGRWDTP52CG"
Response
The holder record and its rank. Retry-After is present when rank is null and still being computed.
1-based position by balance desc, holder asc. Exact when holder_count is at most 100,000. Null while the rank of a large asset is being computed: rank_note says so, the response carries Retry-After and the answer is not charged.
x >= 1True when rank is exact; false when it comes from the periodic refresh (rank_as_of) or is null.
x >= 0Present when the asset has more than 100,000 holders: rank comes from a periodic refresh at this ledger.
x >= 1Present while the rank is being computed (rank is null). Retry after the Retry-After header; this answer is not charged.
The M… address from the request, when one was sent.