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"

Response

The registry record with its links.

​
read_view
object
required
​
asset
string
required

Canonical asset ID: native, CODE:ISSUER (case-sensitive, never padded), a C… contract ID for a custom token, or pool:<64 hex> for a liquidity pool share. A Stellar Asset Contract ID is accepted as an alias and resolves to its classic CODE:ISSUER.

​
asset_type
enum<string>
required
Available options:
native,
credit_alphanum4,
credit_alphanum12,
pool_share,
contract
​
kind
enum<string>
required

native for XLM, classic for CODE:ISSUER (with its SAC when deployed), sep41 for a custom contract token, pool_share for a liquidity pool share.

Available options:
native,
classic,
sep41,
pool_share
​
contract_id
string | null
required

SAC contract ID for a classic asset, or the token contract. Null when no SAC is deployed.

​
code
string | null
required
​
issuer
string | null
required

Null for native, pool shares and custom tokens.

​
name
string | null
required

From contract metadata; null when unknown (classic assets have none).

​
symbol
string | null
required
​
decimals
integer | null
required

7 for native, classic and pool shares; null when a custom token's decimals are unknown.

Required range: 0 <= x <= 38
​
layout
enum<string> | null
required

How balances of this asset are stored and read. sac: native XLM and classic assets (trustlines and their Stellar Asset Contract). ledger_entry: liquidity pool shares, read from pool share trustlines. balance_i128: a custom contract token whose SEP-41 balance storage is recognized. unknown: a contract token whose storage layout is not recognized (its balances are unverified). Null when no layout is recorded.

Available options:
sac,
ledger_entry,
balance_i128,
unknown
​
verified
boolean
required

Balances of this token are read from ledger entries or a recognized SEP-41 layout.

​
metadata_source
string | null
required

Where name, symbol and decimals came from; null when no metadata was read (classic assets).

​
home_domain
string | null
required

Issuer home domain; null when unset.

​
toml
object | null
required

SEP-1 stellar.toml currency fields from home_domain. Null until fetched; stellar.toml fetching is not enabled yet, so this is currently always null.

​
flags
enum<string>[]
required

Registry labels. unverified_token: SEP-41 storage layout not verified. unreadable_metadata: contract metadata could not be read. impersonation_risk: the code, name or symbol imitates a well-known asset from another issuer. likely_spam: matches spam heuristics. auth_required, auth_revocable, auth_immutable, auth_clawback_enabled: classic issuer account flags (0x1, 0x2, 0x4, 0x8), cleared when the issuer account is deleted. Flags label one asset ID; tokens are never merged or hidden by symbol.

Available options:
unverified_token,
unreadable_metadata,
impersonation_risk,
likely_spam,
auth_required,
auth_revocable,
auth_immutable,
auth_clawback_enabled
​
holder_count
integer
required

Holders with a non-zero balance, for every kind including pool shares (trustline and contract holders merged; archived contract balances included). For pool shares, pool.trustline_count also counts zero-balance trustlines.

Required range: x >= 0
​
supply
string | null
required

Sum of every balance of the asset in the state index: account trustlines (or XLM account balances) plus SAC and custom-token contract balances, including archived ones. Claimable balances and liquidity pool reserves are not included. Null while not computed. Decimal string using the token's decimals (7 for XLM, classic assets and SACs). Never a float.

​
supply_raw
string | null
required

Same as supply. Exact integer string (up to i128).

Pattern: ^-?[0-9]+$
​
supply_source
enum<string>
required

exact for ledger-derived supply; derived for custom tokens (sum of known balances).

Available options:
exact,
derived
​
first_seen_ledger
integer
required

First ledger the token was observed. 0 when unknown: assets already present at the bootstrap checkpoint have no recorded first appearance.

Required range: x >= 0
​
_links
object
required
​
pool
object

Liquidity pool shares only.

​
requested_as
string

Present when the request named the asset by another ID (for example a SAC contract ID); asset is the canonical ID.

​
archived_holder_count
integer

Detail only: the part of holder_count held in archived contract balances (live holders = holder_count - archived_holder_count). Absent while not computed.

Required range: x >= 0
​
archived_supply
string

Detail only: the part of supply held in archived contract balances. Absent while not computed. Decimal string using the token's decimals (7 for XLM, classic assets and SACs). Never a float.

​
archived_supply_raw
string

Same as archived_supply. Exact integer string (up to i128).

Pattern: ^-?[0-9]+$