BlockonomicsAPI Reference

Wallets

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

5 endpoints

Endpoints

List all wallets
GET/v2/wallets
Add a wallet
POST/v2/wallets
Get wallet details
GET/v2/wallets/{id}
Update a wallet
POST/v2/wallets/{id}
Delete a wallet
DELETE/v2/wallets/{id}
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
  }
}
GET/v2/walletsAuth required

List all wallets

Returns a list of all wallets associated with your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Query Parameters

balancebooleandefault: false

Whether to include balance information

Responses

dataarray[]View wallet object
balancequery · boolean

Whether to include balance information

Response will appear here

POST/v2/walletsAuth required

Add a wallet

Attach a new wallet to your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Request Body

namestring

Name your wallet for easier identification

addressstringrequired

Wallet address. For BTC: xPub address. For USDT: EVM address (0x...).

cryptostringrequired

Type of crypto. Supported values: BTC, USDT.

Responses

dataobjectView wallet
namebody · string

Name your wallet for easier identification

addressbody · stringrequired

Wallet address. For BTC: xPub address. For USDT: EVM address (0x...).

cryptobody · stringrequired

Type of crypto. Supported values: BTC, USDT.

Response will appear here

GET/v2/wallets/{id}Auth required

Get wallet details

Returns details of a specific wallet.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the wallet

Query Parameters

balancebooleandefault: false

Whether to include balance information

Responses

dataobjectView wallet
idpath · integerrequired

The unique ID of the wallet

balancequery · boolean

Whether to include balance information

Response will appear here

POST/v2/wallets/{id}Auth required

Update a wallet

Update the details of a specific wallet.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the wallet

Request Body

namestring

Give a new name to the wallet

gap_limitinteger

The number of unused addresses to check before considering the wallet as inactive. Do not touch this unless you know what you are doing.

Responses

dataobjectView wallet
idpath · integerrequired

The unique ID of the wallet

namebody · string

Give a new name to the wallet

gap_limitbody · integer

The number of unused addresses to check before considering the wallet as inactive. Do not touch this unless you know what you are doing.

Response will appear here

DELETE/v2/wallets/{id}Auth required

Delete a wallet

Remove a wallet from your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the wallet

Responses

idpath · integerrequired

The unique ID of the wallet

Response will appear here