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:

"GCMIOIR346PXAPZB7J3SI4UCP5SAGSKNABB73K5FJPGIMYLMIV2UEHPA"

Query Parameters

role
enum<string>
default:claimant

claimant (default): balances the address can claim. sponsor: balances whose reserve the address sponsors.

Available options:
claimant,
sponsor
Example:

"claimant"

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 claimable balances.

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).

role
enum<string>
required
Available options:
claimant,
sponsor