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 |
Response Parameters#
| Field | Type | Description |
|---|---|---|
| holdPercent | String | Percentage of holdings |
| 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
{
"code": "0",
"data": [
{
"avgBuyPrice": "0",
"avgSellPrice": "0",
"boughtAmount": "0",
"fundingSource": "FE86HYyFkqRVk2fNy6TUatrpoekQmcC2Pa8iybc7wZzU",
"holdAmount": "96080378.806242",
"holdPercent": "9.608239644552870900",
"holderWalletAddress": "9SLPTL41SPsYkgdsMzdfJsxymEANKr5bYoBsQzJyKpKS",
"nativeTokenBalance": "215136.210273336",
"realizedPnlUsd": "0",
"totalPnlUsd": "0.00000000000000000",
"totalSellAmount": "0",
"unrealizedPnlUsd": "0.00000000000000000"
},
{
"avgBuyPrice": "",
"avgSellPrice": "",
"boughtAmount": "",
"fundingSource": "APhyMCpYjQ9RdEBn8cs4ifyBXjxAS5JtM3wYpWMJjsY5",
"holdAmount": "48368067.930867",
"holdPercent": "4.836908363579335500",
"holderWalletAddress": "u6PJ8DtQuPFnfmwHbGFULQ4u4EgjDiyYKjVEsynXq2w",
"nativeTokenBalance": "63212.857153485",
"realizedPnlUsd": "",
"totalPnlUsd": "",
"totalSellAmount": "",
"unrealizedPnlUsd": ""
}
],
"msg": ""
}