TAtatum
Multi Tokens (ERC-1155 or compatible)

Get the amount of one or multiple Multi Tokens for multiple blockchain addresses

/v3/multitoken/balance/batch/{chain}/{contractAddress}

1 credit per API call

For multiple blockchain addresses, get the amount of one or multiple Multi Tokens (minted on the smart contract specified by the contractAddress path parameter in the request endpoint URL) that those addresses hold.

This API is supported for the following blockchains:

  • BNB Smart Chain
  • Celo
  • Ethereum
  • Harmony
  • Klaytn
  • KuCoin Community Chain
  • Polygon
  • Flare
  • Cronos
  • Base
  • Avalanche
  • Fantom
  • Optimism
get/v3/multitoken/balance/batch/{chain}/{contractAddress}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/multitoken/balance/batch/{chain}/{contractAddress}
  • Auth
    API key in header x-api-key

Path parameters

chain'ETH' | 'MATIC' | 'KCS' | 'KLAY' | 'ONE' | 'CELO' | 'BSC' | 'FLARE' | 'CRO' | 'BASE' | 'AVAX' | 'FTM' | 'OPTIMISM' required

Blockchain to work with

contractAddressstring required
Example:0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326

The address of the Multi Token smart contract

Query parameters

tokenIdstring required
Example:1,2,3

Comma-separated IDs of the Multi Tokens to get the amounts for

addressstring required
Example:0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B,0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B,0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B

Comma-separated blockchain addresses to get the token balance for

testnetType'ethereum-sepolia' | 'flare-coston' | 'flare-coston2' | 'flare-songbird'

Specifies the testnet type. The default is ethereum-sepolia for Ethereum (ETH) currency and flare-coston for Flare (FLR) currency. Valid testnet types depend on the specified currency.

Type of testnet in query. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Headers

x-testnet-typeSchema (unresolved $ref)

Type of testnet in header. The default type is based on the currency: ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, this value is ignored. The currency/chain must be specified to determine the applicable set of testnet types.

Response

OK

string[] required

Example response

[
  "10",
  "20"
]

Changes

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