API Endpoint: /defi/v2/tokens/top_traders

Description: This endpoint retrieves the top traders for a specific token based on trading volume (volume of the token amount) or the number of transactions (trade) within a specified time frame. Users can discover the most active traders and gain insights into their trading activities, including identifying types such as bot trading when applicable.

Chain supported: solana, ethereum, arbitrum, avalanche, bsc, optimism, polygon, base, zksync.

Request

Request Method: GET

Data Coverage: Multi-chain

Request URL:

<https://public-api.birdeye.so/defi/v2/tokens/top_traders?sort_by=volume&sort_type=desc&address=0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7&time_frame=24h&offset=0&limit=10>```

Request Headers:

accept: application/json  
X-API-KEY: YOUR_API_KEY
x-chain: solana/ethereum/ etc..

Parameters:

Key	Data Type	Details	Example
`sort_by`	string	The attribute to sort the traders by. Supported values: `volume`, `trade`. Default is `volume`	volume
`sort_type`	string	The order to sort the traders in. Supported values: `asc`, `desc`. Default is `desc`.	desc
`address`	string	The token address to retrieve the top traders for. (Required)	0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7
`time_frame`	string	The time frame for the top traders data. Supported values: `30m`, `1h`, `2h`, `4h`, `6h`, `8h`, `12h`, `24h`. Default is `24h`.	24h
`offset`	integer	The number of records to skip from the start. Default is `0`.	0
`limit`	integer	The maximum number of records to return. Supported values: `1` to `10`, Default is `10`.	10

Note: Solana chain does NOT supporttime_frame 6h and 12h.

Response

The response provides a list of the top traders for the specified token, sorted by the chosen criteria, along with their trading statistics.

Example Request:

\--request GET  
     --url '<https://public-api.birdeye.so/defi/v2/tokens/top_traders?sort_by=volume&sort_type=desc&address=0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7&time_frame=24H&offset=0&limit=10'>  
     --header 'X-API-KEY: YOUR_API_KEY'  
     --header 'accept: application/json'

Example Response:

{
    "success": true,
    "data": {
        "items": [
            {
                "owner": "0x5785Fd6a2C4e11a6F3Cce7dAD5700CA9Db63bbdb",
                "tokenAddress": "0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7",
                "trade": 4,
                "tradeBuy": 4,
                "tradeSell": 0,
                "type": "24h",
                "volume": 394.10190608949824,
                "volumeBuy": 394.10190608949824,
                "volumeSell": 0,
                "tags": []
            },
            {
                "owner": "0x16C473448E770Ff647c69CBe19e28528877fba1B",
                "tokenAddress": "0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7",
                "trade": 5,
                "tradeBuy": 2,
                "tradeSell": 3,
                "type": "24h",
                "volume": 326.9638244478502,
                "volumeBuy": 294.7094594425826,
                "volumeSell": 32.25436500526758,
                "tags": [
                    "arbitrage-bot",
                    "sniper-bot"
                ]
            },
            {
                "owner": "0x6bF52B769ac1697E8046568dd9af25a0833301db",
                "tokenAddress": "0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7",
                "trade": 2,
                "tradeBuy": 0,
                "tradeSell": 2,
                "type": "24h",
                "volume": 322.34765119398935,
                "volumeBuy": 0,
                "volumeSell": 322.34765119398935,
                "tags": []
            }
        ]
    }
}

Response Parameters:

Key	Data type	Details	Example
`createdAt`	string	The timestamp when the record was created.	"2024-07-23T01:45:10.277Z"
`owner`	string	The address of the trader.	"0x171c53d55B1BCb725F660677d9e8BAd7fD084282"
`tokenAddress`	string	The address of the token.	"0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7"
`trade`	integer	The total number of trades.	3
`tradeBuy`	integer	The number of buy trades.	0
`tradeSell`	integer	The number of sell trades.	3
`type`	string	The time frame for the data.	"24h"
`updateTime`	integer	The Unix timestamp of the last update.	1721718600
`updatedAt`	string	The human-readable time of the last update.	"2024-07-23T07:10:11.360Z"
`volume`	number	The total trading volume (token amount).	762.1365652097866
`volumeBuy`	number	The total buy trading volume (token amount).	0
`volumeSell`	number	The total sell trading volume (token amount).	762.1365652097866
`tags`	array	Tags associated with the trader, such as bot types.	[ "arbitrage-bot", "sniper-bot" ][ "arbitrage-bot", "sniper-bot" ]