nr_getHistoryTokenHolder

This API helps you to get the historical token holder list by giving the contract address, block number, and resource ID. Supports both fungible tokens(ERC-20, BEP-20) and NFT(ERC-721, BEP-721, ERC-1155, BEP-1155).

📘

Supported on BSC mainnet only.

Available token type:

  • Fungible token (ERC-20, BEP-20)
  • NFT (ERC-721, BEP-721, ERC-1155, BEP-1155)

🚧

This API is an async task that requires the result from nr_historytokenholdersend API. Before calling this API, please submit a request to nr_historytokenholdersend to get the resource ID.

Parameters

Returns

  • result
    • status - 0: Error; 1: Success; 2: Generating; 3: Incorrect resource ID
    • links - the link of the token holder list, in JSON file format

API Endpoint

The endpoint of this API is https://open-platform.nodereal.io/{API-KEY}/tokenholder/
Here is an example:

https://open-platform.nodereal.io/64a9df0874fb4a93b9d0a3849de012d3/tokenholder/

You could refer to this guidance Find API key & endpoint for the API key.

Example

Request

curl https://open-platform.nodereal.io/v1/your-api-key \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"nr_getHistoryTokenHolder","params":["0xeDa21B525Ac789EaB1a08ef2404dd8505FfB973D","0x1550e20", "a4a4b76170ddc1w2d060717342826c31ca4307w8d3edfbb01593f5c48c78b7ab"],"id": 1 }'

Result

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "status": 1,
        "links": [
            "https://tf-nodereal-prod-bsc-gold-digger.s3.amazonaws.com/public/a4a4b76170ddc1w2d060717342826c31ca4307w8d3edfbb01593f5c48c78b7ab"
        ]
    }
}

🚧

Please note that the file from the result will only be available for 24 hours. You would need to submit a new task if the file is expired.

You will see the historical token holder list data in the file, including:

  • blockNumber
  • tokenAddress
  • holders (array)
    • account
    • balance
    • tokenType (if NFT)
    • tokenId (if NFT)
{
   "blockNumber":22351392,
   "tokenAddress":"0x15b3d410fcd0d695e1bbe4f717f8e1b6d0fb2d0c",
   "holders":[
      {
         "account":"0x2f003ce63d5ebe72d9cb5afd94b00b14d75d47be",
         "balance":"0x0000000000000000000000000000000000000000000000000de0b6b3a7640000"
      },
      {
         "account":"0x68368ef36bb436f92b20d97b64fc080212821be5",
         "balance":"0x0000000000000000000000000000000000000000000000000000006c86d6dda0"
      },
      {
         "account":"0x949716fba215f35ecdc1a8fcdd1960b8d18e7510",
         "balance":"0x0000000000000000000000000000000000000000000000000070c9be58939bf6"
      }
     ...
   ]
}