Skip to main content
GET
Get on-chain balance

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Response

200 - application/json

Returns the on-chain balance

confirmed_sat
integer<int64>
required

Confirmed and immediately spendable balance

Required range: x >= 0
immature_sat
integer<int64>
required

All coinbase outputs not yet matured

Required range: x >= 0
total_sat
integer<int64>
required

All of them combined.

Required range: x >= 0
trusted_pending_sat
integer<int64>
required

Unconfirmed UTXOs generated by a wallet tx

Required range: x >= 0
trusted_spendable_sat
integer<int64>
required

Get sum of trusted_pending and confirmed coins.

This is the balance you can spend right now that shouldn't get canceled via another party double spending it.

Required range: x >= 0
untrusted_pending_sat
integer<int64>
required

Unconfirmed UTXOs received from an external wallet

Required range: x >= 0