Skip to main content
POST
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.

Headers

Idempotency-Key
string

Optional, 8 to 128 characters. Resending the same key with the same request returns the existing job (200, no new charge); the same key with a different request returns 409. It deduplicates on every plan, with no expiry.

Required string length: 8 - 128
Example:

"retry-0001-2026-10-22"

Body

application/json
kind
enum<string>
required

holdings: one address's holdings; holders: an asset's ranked holders.

Available options:
holdings,
holders
as_of_ledger
integer
required

Any past ledger from 63 up to the latest applied ledger; it may be before bootstrap_ledger.

Required range: x >= 63
address
string

G or C address. Required for holdings.

asset
string

Asset ID (native, CODE:ISSUER, a C… token contract or pool:<64 hex>). Required for holders.

Response

The same Idempotency-Key and request were sent before: the existing job, not charged again.

id
string<uuid>
required
kind
enum<string>
required
Available options:
holdings,
holders
params
object
required
status
enum<string>
required
Available options:
queued,
running,
completed,
failed
created_at
string<date-time>
required
muxed_input
string

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

result
object

A flat list of balances at as_of_ledger. Unlike the live routes it has no read_view, _links or paging.

error
string

Why the job failed.

finished_at
string<date-time>