Token - Holder (Batch)

Retrieve the token balance held by a list of wallet owners.

post/token/v1/holder/batch

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/token/v1/holder/batch/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

ui_amount_mode'raw' | 'scaled'

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

Headers

x-chain'solana'

Solana network only.

Request body

walletsstring[] required

Wallet owner addresses to check. Supports 1 to 500 wallets per request.

token_addressstring required

Token mint address to check in each wallet.

Example request

{
  "wallets": [
    "5Q544fKrFoe6tsEbD7S8EmxGTJYAKtTVhAW5Q5pge4j1",
    "2fgUSSpZFi8PjyhbrETSeLutJpFsuCfWsk2H6gb3Reye"
  ],
  "token_address": "So11111111111111111111111111111111111111112"
}

Response

JSON object containing token balances held by a list of wallet owners

successboolean required

Indicates whether the request was successful.

Changes

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