Get Token Holder List#
Get the list of positions of a token under a chain, return only the address with a balance of top10000.
Request Path#
GET
https://web3.okx.com/api/v5/xlayer/token/position-listRequest Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
| chainShortName | String | Yes | The abbreviated name of the blockchain network, e.g, XLAYER. |
| tokenContractAddress | String | Yes | Token Contract Address |
| holderAddress | String | No | Holder address |
| page | String | No | Page |
| limit | String | No | The number of results returned per request. The maximum is 50. The default is 20. |
Response Parameters#
| Parameter | Type | Description |
|---|---|---|
| page | String | Current page number |
| limit | String | The amount of data |
| totalPage | String | Total number of pages |
| chainFullName | String | The full name of the blockchain network, e.g. X Layer |
| chainShortName | String | The abbreviated name of the blockchain network, e.g. XLAYER |
| circulatingSupply | String | Circulating Supply |
| positionList | Array | Position List |
| > holderAddress | String | Holder Address |
| > amount | String | Holding amount |
| > valueUsd | String | Value of positions, Unit: USD |
| > positionChange24h | String | 24 hour position changes |
| > rank | String | Position ranking |
Request Example#
shell
curl --location --request GET 'https://web3.okx.com/api/v5/xlayer/token/position-list?chainShortName=xlayer&tokenContractAddress=0x1e4a5963abfd975d8c9021ce480b42188849d41d&limit=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",
"msg": "",
"data": [
{
"page": "1",
"limit": "1",
"totalPage": "10000",
"chainFullName": "X Layer",
"chainShortName": "XLAYER",
"circulatingSupply": "158626664755.6",
"positionList": [
{
"holderAddress": "0xb543ef701c5f5f00de7eb98fd8138b0e33327893",
"amount": "0.000006",
"valueUsd": "0.00000600354",
"positionChange24h": "",
"rank": "1"
}
]
}
]
}