BlockonomicsAPI Reference

Wallets

Add and manage xPub (BTC) or EVM (USDT) wallets, track balances, and configure wallet settings.

5 endpoints

object

The wallet object

A wallet holds an xPub address (BTC) or EVM address (USDT) and tracks your Bitcoin or USDT balances.

Attributes

idinteger

Unique identifier of the wallet

namestring

Given name

emailidstring

Email of the wallet owner

cryptostring

Cryptocurrency of the wallet

addressstring

Address of the wallet

xpub_indexinteger

The current xPub index for BTC wallet

gap_limitinteger

The gap limit for BTC wallet

created_atstring (date-time)

Datetime of the wallet creation

balanceobject

Aggregate wallet balance (only present when balance=true is requested).

Show nested fields
confirmed_satsinteger

Confirmed balance in satoshis.

unconfirmed_satsinteger

Unconfirmed balance in satoshis.

confirmed_fiatnumber

Confirmed balance in fiat currency.

unconfirmed_fiatnumber

Unconfirmed balance in fiat currency.

fiat_currencystring

Fiat currency code.

total_addressesinteger

Total number of derived addresses.

Example object

{
  "id": 0,
  "name": "",
  "emailid": "",
  "crypto": "",
  "address": "",
  "xpub_index": 0,
  "gap_limit": 0,
  "created_at": "2024-01-01T00:00:00Z",
  "balance": {
    "confirmed_sats": 0,
    "unconfirmed_sats": 0,
    "confirmed_fiat": 0,
    "unconfirmed_fiat": 0,
    "fiat_currency": "",
    "total_addresses": 0
  }
}