GET
/
v1
/
{chainName}
/
tokens
/
{tokenAddress}
/
token_holders_v2
import { GoldRushClient } from "@covalenthq/client-sdk";

const ApiServices = async () => {
    const client = new GoldRushClient("YOUR_API_KEY");
    const resp = await client.BalanceService.getTokenHoldersV2ForTokenAddress({chainName: "chainName", walletAddress: "walletAddress"});
    console.log(resp.data);
};

ApiServices();
{
  "updated_at": "2023-11-07T05:31:56Z",
  "chain_id": 123,
  "chain_name": "<string>",
  "items": [
    {
      "contract_decimals": 123,
      "contract_name": "<string>",
      "contract_ticker_symbol": "<string>",
      "contract_address": "<string>",
      "supports_erc": [
        "<string>"
      ],
      "logo_url": "<string>",
      "address": "<string>",
      "balance": "<string>",
      "total_supply": "<string>",
      "block_height": 123
    }
  ],
  "pagination": {
    "has_more": true,
    "page_number": 123,
    "page_size": 123,
    "total_count": 123
  }
}
Credit Cost: 0.02 per item.
Processing: Realtime

When no block-height is specified, the default is to use the latest token holder snapshot which updates every 30 mins.

To fetch the current token holders list without using the snapshot, set no-snapshot=true.

Page size is either 100 (default) or 1000.

Supported only on Foundational Chains.

Path Parameters

​
chainName
string
required

The chain name eg: eth-mainnet.

​
tokenAddress
string
required

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

Query Parameters

​
no-snapshot
boolean

Defaults to false. Set to true to bypass last snapshot and get the latest token holders list.

​
block-height
integer

Ending block to define a block range. Omitting this parameter defaults to the latest block height.

​
date
string

Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.

​
page-size
integer

Number of items per page. Note: Currently, only values of 100 and 1000 are supported. Omitting this parameter defaults to 100.

​
page-number
integer

0-indexed page number to begin pagination.

Response

200 - application/json
Successful response
​
updated_at
string

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

​
chain_id
integer

The requested chain ID eg: 1.

​
chain_name
string

The requested chain name eg: eth-mainnet.

​
items
object[]

List of response items.

​
pagination
object

Pagination metadata.

Get historical portfolio value over timeGet a transaction