Token Holder Information#
Support viewing the addresses and corresponding position information of the top 100 holders
Request Path#
GET https://web3.okx.com/api/v6/dex/market/token/holder
Request Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
| chainIndex | String | Yes | Unique identifier of the chain. For example: 1: Ethereum. |
| tokenContractAddress | String | Yes | Token contract address (e.g. 0x382bb369d343125bfb2117af9c149795c6c65c50) |
| tagFilter | String | No | Default: No input, return the address data of the first 100 holding coin addresses, arranged in reverse order according to the total income. Enter 1: Return the address labeled KOL Enter 2: Return the token address labeled Developer Enter 3: Return the address labeled Smart Money Enter 4: Return the holding address labeled as Whale Enter 5: Return the address labeled New Wallet Enter 6: Return the holding address labeled Suspicious Enter 7: Return the holding address labeled Sniper Enter 8: Return the address labeled as suspected phishing Enter 9: Return the address labeled as Bundle |
| cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request |
| limit | String | No | Number of records per page, max 100 |
Response Parameters#
| Field | Type | Description |
|---|---|---|
| holdPercent | String | Percentage of holdings |
| cursor | String | Pagination cursor |
| nativeTokenBalance | String | Mainnet currency balance |
| boughtAmount | String | Total Buy Quantity |
| avgBuyPrice | String | Average buying price |
| totalSellAmount | String | Total sold quantity |
| avgSellPrice | String | Average selling price |
| totalPnlUsd | String | Total profit and loss |
| realizedPnlUsd | String | Realized profit and loss |
| unrealizedPnlUsd | String | Unrealized profit and loss |
| fundingSource | String | Sources of funding |
Request Example#
Shell
curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/holder?chainIndex=501&tokenContractAddress=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v&tagFilter=1' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z'
Response Example#
Json
-- Not deep pagination; only supports pagination within up to 100 records returned in memory.
{
"code": "0",
"data": [
{
"avgBuyPrice": "0",
"avgSellPrice": "0",
"boughtAmount": "0",
"fundingSource": "9k8jWWqfmTTXrc8gmZqYVxSFJhygURvyVRztivJXFTYP",
"holdAmount": "767501192.534284",
"holdPercent": "76.750184380179418200",
"holderWalletAddress": "2RH6rUTPBJ9rUDPpuV9b8z1YL56k1tYU6Uk5ZoaEFFSK",
"nativeTokenBalance": "6.091849989",
"realizedPnlUsd": "0",
"totalPnlUsd": "0.000000000000000000",
"totalSellAmount": "0",
"unrealizedPnlUsd": "0.000000000000000000",
"cursor": "0"
},
{
"avgBuyPrice": "0",
"avgSellPrice": "0",
"boughtAmount": "0",
"fundingSource": "5tzFkiKscXHK5ZXCGbXZxdw7gTjjD1mBwuoFbhUvuAi9",
"holdAmount": "36715842.016",
"holdPercent": "3.671587317143695100",
"holderWalletAddress": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"nativeTokenBalance": "13908916.377375046",
"realizedPnlUsd": "0",
"totalPnlUsd": "0.000000000000000000",
"totalSellAmount": "0",
"unrealizedPnlUsd": "0.000000000000000000",
"cursor": "1"
}
],
"msg": ""
}