Get Bitcoin balances for HD address

GET

btc-mainnet

address

{walletAddress}

hd_wallets

^{Credit Cost: 0.1 per item.}
^{Processing: Realtime}

Requests that return status 200 and no data cost 0.1 credits.

Path Parameters

walletAddress

string

required

The extended public key (xPub/yPub/zPub) of the HD wallet.

Query Parameters

quote-currency

string

The currency to convert the balance to. Supports USD, CAD, EUR, etc.

Response

200 - application/json

address

string

The extended public key (xPub/yPub/zPub) or HD wallet address.

chain_id

integer

The requested chain ID eg: 20090103.

chain_name

string

The requested chain name eg: btc-mainnet.

quote_currency

string

The requested quote currency eg: USD.

updated_at

string

The timestamp when the response was generated. Useful to show data staleness to users.

items

object[]

List of HD wallet balance items, each containing derived addresses and balances.

items.child_address

string

The specific Bitcoin address derived from the HD wallet.

items.address_path

string

Derivation path used to derive the specific Bitcoin address, e.g., M/0H/0/0.

items.contract_decimals

integer

Use contract decimals to format the token balance for display purposes - divide the balance by 10^{contract_decimals}.

items.contract_name

string

The name of the token, e.g., Bitcoin.

items.contract_ticker_symbol

string

The ticker symbol for the token, e.g., BTC.

items.contract_address

string

Address placeholder for native tokens like BTC.

items.contract_display_name

string

A display-friendly name for the token, e.g., Bitcoin.

items.supports_erc

string[]

Typically null for Bitcoin, but left for compatibility.

items.logo_url

string

The contract logo URL.

items.logo_urls

object

The contract logo URLs.

items.last_transferred_at

string

The timestamp when the token was last transferred.

items.native_token

boolean

Indicates if a token is the chain's native gas token, eg: BTC on Bitcoin.

items.type

string

One of cryptocurrency, stablecoin, nft or dust.

items.is_spam

boolean

Denotes whether the token is suspected spam.

items.balance

string

b;The asset balance. Use contract_decimals to scale this balance for display purposes.

items.balance24h

string

b;The 24h asset balance. Use contract_decimals to scale this balance for display purposes.

items.quote_rate

number

The exchange rate for the requested quote currency.

items.quote_rate24h

number

The 24h exchange rate for the requested quote currency.

items.quote

number

The current balance converted to fiat in quote-currency.

items.quote24h

number

The 24h balance converted to fiat in quote-currency.

items.pretty_quote

string

A prettier version of the quote for rendering purposes.

items.pretty_quote24h

string

A prettier version of the 24h quote for rendering purposes.

items.protocol_metadata

object

The protocol metadata.

items.nft_data

string

NA for bitcoin.

Get NFT approvals for address Get Bitcoin balances for non-HD address

API Reference

Cross Chain

Balances

Transactions

NFT

Security

Bitcoin

Utility

Path Parameters

Query Parameters

Response