Bitcoin
Get Bitcoin balances for HD address
Cross Chain
Balances
Transactions
- GETGet a transaction
- GETGet transaction summary for address
- GETGet earliest transactions for address (v3)
- GETGet recent transactions for address (v3)
- GETGet paginated transactions for address (v3)
- GETGet bulk time bucket transactions for address (v3)
- GETGet all transactions in a block by page (v3)
- GETGet all transactions in a block (v3)
NFT
Bitcoin
Bitcoin
Get Bitcoin balances for HD address
Fetch balances for each active child address derived from a Bitcoin HD wallet.
GET
/
v1
/
btc-mainnet
/
address
/
{walletAddress}
/
hd_wallets
import { GoldRushClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new GoldRushClient("YOUR_API_KEY");
const resp = await client.BalanceService.getBitcoinHdWalletBalances({chainName: "chainName", walletAddress: "walletAddress"});
console.log(resp.data);
};
ApiServices();
{
"address": "<string>",
"chain_id": 123,
"chain_name": "<string>",
"quote_currency": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"child_address": "<string>",
"address_path": "<string>",
"contract_decimals": 123,
"contract_name": "<string>",
"contract_ticker_symbol": "<string>",
"contract_address": "<string>",
"contract_display_name": "<string>",
"supports_erc": [
"<string>"
],
"logo_url": "<string>",
"logo_urls": {
"token_logo_url": "<string>",
"protocol_logo_url": "<string>",
"chain_logo_url": "<string>"
},
"last_transferred_at": "2023-11-07T05:31:56Z",
"native_token": true,
"type": "<string>",
"is_spam": true,
"balance": "<string>",
"balance_24h": "<string>",
"quote_rate": 123,
"quote_rate_24h": 123,
"quote": 123,
"quote_24h": 123,
"pretty_quote": "<string>",
"pretty_quote_24h": "<string>",
"protocol_metadata": {
"protocol_name": "<string>"
},
"nft_data": "<string>"
}
]
}
Credit Cost
0.1 per item
Processing
Realtime
Requests that return status 200 and no data cost 0.1 credits.
Authorizations
Bearer authentication header of the form: Bearer <token>
, where <token>
is your GoldRush API Key.
Path Parameters
The extended public key (xPub/yPub/zPub) of the HD wallet.
Query Parameters
The currency to convert the balance to. Supports USD
, CAD
, EUR
, etc.
Response
200 - application/json
Successful response
The response is of type object
.
import { GoldRushClient } from "@covalenthq/client-sdk";
const ApiServices = async () => {
const client = new GoldRushClient("YOUR_API_KEY");
const resp = await client.BalanceService.getBitcoinHdWalletBalances({chainName: "chainName", walletAddress: "walletAddress"});
console.log(resp.data);
};
ApiServices();
{
"address": "<string>",
"chain_id": 123,
"chain_name": "<string>",
"quote_currency": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"child_address": "<string>",
"address_path": "<string>",
"contract_decimals": 123,
"contract_name": "<string>",
"contract_ticker_symbol": "<string>",
"contract_address": "<string>",
"contract_display_name": "<string>",
"supports_erc": [
"<string>"
],
"logo_url": "<string>",
"logo_urls": {
"token_logo_url": "<string>",
"protocol_logo_url": "<string>",
"chain_logo_url": "<string>"
},
"last_transferred_at": "2023-11-07T05:31:56Z",
"native_token": true,
"type": "<string>",
"is_spam": true,
"balance": "<string>",
"balance_24h": "<string>",
"quote_rate": 123,
"quote_rate_24h": 123,
"quote": 123,
"quote_24h": 123,
"pretty_quote": "<string>",
"pretty_quote_24h": "<string>",
"protocol_metadata": {
"protocol_name": "<string>"
},
"nft_data": "<string>"
}
]
}