Token - Holder

Retrieve a list of top holders of a specified token.

get/defi/v3/token/holder

Request

Base URL
https://public-api.birdeye.so
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/birdeye/apis/birdeye-data-api/docs/defi/v3/token/holder/get.ts
A function with typed inputs. Its response is checked against the schema.

addressstring required

The address of the token contract.

offsetinteger

Pagination start position. offset + limit <= 10000

limitinteger

Number of items per page.

ui_amount_mode'raw' | 'scaled'

Indicate whether to use the scaled amount for scaled ui amount tokens. Only support solana

x-chain'solana'

Solana network only.

JSON object containing a list of token holder

successboolean required

Indicates whether the request was successful.

No recorded changes to this operation across all 1 revision of this API.