TAtatum
Fungible Tokens (ERC-20 or compatible)

Get the number of fungible tokens that a blockchain address holds in a smart contract

/v3/blockchain/token/balance/{chain}/{contractAddress}/{address}

1 credit per API call

Get the number of the fungible tokens minted on a specific smart contract (the contractAddress path parameter in the request endpoint URL) that a blockchain address holds.

This API is supported for the following blockchains:

  • Algorand
  • BNB Smart Chain
  • Celo
  • Elrond
  • Ethereum
  • Harmony
  • Klaytn
  • KuCoin Community Chain
  • Polygon
  • Solana
  • XinFin
  • Flare
  • Cronos
  • Base
  • Avalanche
  • Fantom
  • Optimism
get/v3/blockchain/token/balance/{chain}/{contractAddress}/{address}

Request

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

Path parameters

chain'CELO' | 'ALGO' | 'MATIC' | 'ETH' | 'BSC' | 'XDC' | 'KLAY' | 'ONE' | 'EGLD' | 'KCS' | 'SOL' | 'FLR' | 'CRO' | 'BASE' | 'AVAX' | 'FTM' | 'OPTIMISM' required
Example:CELO

Network name

addressstring required
Example:0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B

The blockchain address that you want to get the token balance of

contractAddressstring required
Example:0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326

The address of the fungible token smart contract

Query parameters

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

balancestring

The number of fungible tokens in the smallest token unit (for example, if the token has 10 decimal places, the number is returned as 9*10^10)

Example response

{
  "balance": "10"
}

Changes

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