For the complete documentation index, see llms.txt. This page is also available as Markdown.

Addresses

Get Address Balance (with optional mempool)

get

Returns total and locked balances for the specified address. If mempool=true, balances will include the effect of unconfirmed transactions.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

The address to query.

Example: 12jK2jHyyJTJyuRMRya7QJSojgVnb5yh4HVzNNw6BTBDF
Query parameters
mempoolbooleanOptional

Whether to include unconfirmed (mempool) transactions in the balance calculation.

Default: falseExample: true
Responses
200

Address balance retrieved successfully.

application/json
balancestringOptional

Total balance in atto-ALPH.

Example: 465478842708706554897
balanceHintstringOptional

Readable ALPH balance.

Example: 465.478842708706554897 ALPH
lockedBalancestringOptional

Locked balance in atto-ALPH.

Example: 461357694374776064051
lockedBalanceHintstringOptional

Readable locked balance in ALPH.

Example: 461.357694374776064051 ALPH
utxoNumintegerOptional

Number of unspent outputs for the address.

Example: 2459
get/addresses/{address}/balance

Get UTXOs for Address

get

Returns all unspent outputs (UTXOs) associated with a specific address.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

The address whose UTXOs are requested.

Example: 12jK2jHyyJTJyuRMRya7QJSojgVnb5yh4HVzNNw6BTBDF
Responses
200

List of UTXOs retrieved successfully.

application/json
get/addresses/{address}/utxos

Get Group Number by Address

get

Returns the group number for the specified address.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

The address to query.

Example: 12jK2jHyyJTJyuRMRya7QJSojgVnb5yh4HVzNNw6BTBDF
Responses
200

Group number retrieved successfully.

application/json
groupintegerOptional

The group number associated with the address.

Example: 2
get/addresses/{address}/group

Last updated