GET
/
v1
/
{chainName}
/
address
/
{walletAddress}
/
balances_v2
import { GoldRushClient } from "@covalenthq/client-sdk";

const ApiServices = async () => {
    const client = new GoldRushClient("YOUR_API_KEY");
    const resp = await client.BalanceService.getTokenBalancesForWalletAddress({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": [
    {
      "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": [
        {
          "token_id": "<string>",
          "token_balance": "<string>",
          "token_url": "<string>",
          "supports_erc": [
            "<string>"
          ],
          "token_price_wei": "<string>",
          "token_quote_rate_eth": "<string>",
          "original_owner": "<string>",
          "external_data": {
            "name": "<string>",
            "description": "<string>",
            "image": "<string>",
            "image_256": "<string>",
            "image_512": "<string>",
            "image_1024": "<string>",
            "animation_url": "<string>",
            "external_url": "<string>",
            "attributes": [
              {
                "trait_type": "<string>",
                "value": "<string>"
              }
            ],
            "thumbnails": {
              "image_256": "<string>",
              "image_512": "<string>",
              "image_1024": "<string>",
              "image_opengraph_url": "<string>",
              "thumbhash": "<string>"
            },
            "image_preview": "<string>",
            "asset_properties": {
              "asset_width": 123,
              "asset_height": 123,
              "dominant_color": "<string>"
            },
            "owner": "<string>"
          },
          "owner": "<string>",
          "owner_address": "<string>",
          "burned": true
        }
      ]
    }
  ]
}

Credit Cost

1 per call

Processing

Realtime

Path Parameters

​
chainName
string
required

The chain name eg: eth-mainnet.

​
walletAddress
string
required

The requested address. Passing in an ENS, RNS, Lens Handle, or an Unstoppable Domain resolves automatically.

Query Parameters

​
quote-currency
string

The currency to convert. Supports USD, CAD, EUR, SGD, INR, JPY, VND, CNY, KRW, RUB, TRY, NGN, ARS, AUD, CHF, and GBP.

​
nft
boolean

If true, NFTs will be included in the response.

​
no-nft-fetch
boolean

If true, only NFTs that have been cached will be included in the response. Helpful for faster response times.

​
no-spam
boolean

If true, the suspected spam tokens are removed. Supports eth-mainnet and matic-mainnet.

​
no-nft-asset-metadata
boolean

If true, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.

Response

200 - application/json
Successful response
​
address
string

The requested address.

​
chain_id
integer

The requested chain ID eg: 1.

​
chain_name
string

The requested chain name eg: eth-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 response items.