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

address
string
required

Checksum-valid G or C address. An M… address resolves to its G account and the response carries muxed_input. B… and L… addresses are never holders.

Example:

"GAIH3ULLFQ4DGSECF2AR555KZ4KNDGEKN4AFI4SU2M7B43MGK3QJZNSR"

Query Parameters

kind
enum<string>

Only holdings of this kind.

Available options:
native,
trustline,
pool_share,
contract
Example:

"trustline"

min_balance
string

Decimal; holdings below it are left out.

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"1"

include
string

Comma list: zero (zero-balance trustlines), closed (previously held, with closed_ledger), unverified (event-derived or simulated custom-token balances). Default: none of them.

Pattern: ^(zero|closed|unverified)(,(zero|closed|unverified))*$
Example:

"zero"

asset
string

Only this asset: native, CODE:ISSUER (case-sensitive), a C… token contract ID or pool:<64 hex>. A Stellar Asset Contract ID matches the balances of its classic asset (CODE:ISSUER, or native for the native SAC), which records report under that classic ID.

as_of_ledger
integer

Read at this past ledger from the balance history (credit class assets-history, weight 5). 400 when after the latest applied ledger; 409 when the history cannot answer it exactly. Not available to publishable keys.

Required range: x >= 1
Example:

5300000

limit
integer
default:50

Records per page, 1 to 200 (default 50).

Required range: 1 <= x <= 200
Example:

10

cursor
string

Resume after this paging_token. Prefer following _links.next.href.

Response

A page of holdings, the completeness block and, for a G account, the account entry.

read_view
object
required
limit
integer
required

Effective page size: default 50, maximum 200.

_embedded
object
required
address
string
required

The looked-up address (G or C; an M… input resolves to its G account).

completeness
object
required
account
object | null

G accounts only: the account entry, or null when the account does not exist. Absent for C addresses.

muxed_input
string

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