Skip to main content
GET
Balances for a customer wallet

Authorizations

X-API-Key
string
header
required

Business API key for server-to-server integrations. Key prefix determines the environment — no separate flag needed: test_sk_* = sandbox/testnet, live_sk_* = production/mainnet.

Path Parameters

customerID
string
required

Query Parameters

refresh
boolean

Schedule a monitor re-read of these addresses on its next cycle and return stored balances immediately. Does NOT block on a chain read.

live
boolean

Read the chain directly instead of the stored figure. Throttled per address; use only when you need the confirmed/unconfirmed split or are auditing for drift.

Response

Balances per address

customer_id
string
addresses
object[]
total
integer
note
string

Explains the database-backed behaviour and the refresh/live options.

refresh_requested
boolean

Present only when ?refresh=true or ?live=true was passed.

Example:

true

refresh_eta_seconds
integer

Roughly how long until a requested refresh is reflected. Poll again after this interval.

Example:

30