Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

asset
string
required

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.

Example:

"BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX"

address
string
required

Checksum-valid G or C holder address. An M… address resolves to its G account and the response carries muxed_input.

Example:

"CCSXXPCXICXOC2MLU3UINWYKL6M5VNLVOTHA4ZQ5S5BEDZGRWDTP52CG"

Response

The holder record and its rank. Retry-After is present when rank is null and still being computed.

read_view
object
required
record
object
required
rank
integer | null
required

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.

Required range: x >= 1
rank_exact
boolean
required

True when rank is exact; false when it comes from the periodic refresh (rank_as_of) or is null.

holder_count
integer
required
Required range: x >= 0
rank_as_of
integer

Present when the asset has more than 100,000 holders: rank comes from a periodic refresh at this ledger.

Required range: x >= 1
rank_note
string

Present while the rank is being computed (rank is null). Retry after the Retry-After header; this answer is not charged.

muxed_input
string

The M… address from the request, when one was sent.