Get wallet portfolio
Changed on/v4/data/wallet/portfolio
50 credits per API call
Get portfolio balances of native, fungible tokens (ERC-20) or NFTs (ERC-721 and ERC-1155) for a specific wallet address on the following blockchains:
- Ethereum - ethereum-mainnet / ethereum-sepolia
- Solana - solana-mainnet / solana-devnet
- Base - base-mainnet / base-sepolia
- Arbitrum - arb-one-mainnet / arb-testnet
- BNB (Binance) Smart Chain - bsc-mainnet / bsc-testnet
- Polygon - polygon-mainnet / polygon-amoy
- Optimism - optimism-mainnet / optimism-testnet
- Berachain - berachain-mainnet
- Unichain - unichain-mainnet / unichain-sepolia
- Monad - monad-mainnet / monad-testnet
- Robinhood - robinhood-mainnet / robinhood-testnet
- Celo - celo-mainnet / celo-testnet
- Chiliz - chiliz-mainnet
- Tezos - tezos-mainnet
- Moca Chain - mocachain-devnet
- Avalanche - avax-mainnet / avax-testnet
- Gnosis - gno-mainnet / gno-testnet
- zkSync - zksync-mainnet / zksync-testnet
- Rootstock - rsk-mainnet / rsk-testnet
- Ethereum Classic - ethereum-classic-mainnet / ethereum-classic-testnet
- Lisk - lisk-mainnet / lisk-testnet
- XDC - xdc-mainnet
- Sonic - sonic-mainnet
To get started:
- Provide a chain name and and an address of that chain. Our API will return balances of each token along with further information such as its type, id, and more.
- Aside from relevant information about each token and its balance, the response also contains metadata (they can, however, be excluded by setting excludeMetadata to true).
- The API requires specifying the tokenTypes parameter to indicate which types of tokens to fetch balances for. Supported values include [native], [fungible] and [nft,multitoken].
- For Tezos blockchain, the API returns balance of any tokens including native token (XTZ) for specified wallet addresses. Following query parameters won't have any effect on filtering data excludeMetadata.
Request
- Base URLhttps://api.tatum.io
- URLhttps://api.tatum.io/v4/data/wallet/portfolio
- AuthAPI key in header x-api-key
Query parameters
The blockchain to work with.
Wallet address
The blockchain public wallet addresses. Only one address is allowed.
The option to select only specific token types. Use [native], [fungible] (ERC-20), [nft,multitoken] (includes ERC-721 and ERC-1155)
The option to exclude metadata from the response.
The number of items per page (default is 50).
The offset to obtain next page of the data.
Response
OK
Example response
{
"result": [
{
"chain": "ethereum-mainnet",
"address": "0xae680ed83baf08a8028118bd19859f8a0e744cc6",
"balance": "2.881012674896012762",
"denominatedBalance": "2881012674896012762",
"decimals": 18,
"type": "native"
},
{
"chain": "ethereum-mainnet",
"address": "0xae680ed83baf08a8028118bd19859f8a0e744cc6",
"balance": "283.333333333333333333",
"denominatedBalance": "283333333333333333333",
"decimals": 18,
"tokenAddress": "0x45dd18c5e0fa701abff449f6542aa53e258710b4",
"type": "fungible"
},
{
"chain": "ethereum-mainnet",
"address": "0xae680ed83baf08a8028118bd19859f8a0e744cc6",
"balance": "8.69",
"denominatedBalance": "8690000000000000000",
"decimals": 18,
"tokenAddress": "0x090f21a84a0e9674c1828aca1db69ec8ae1454e8",
"type": "fungible"
},
{
"chain": "ethereum-mainnet",
"address": "0xae680ed83baf08a8028118bd19859f8a0e744cc6",
"balance": "1",
"tokenAddress": "0xa58b5224e2fd94020cb2837231b2b0e4247301a6",
"type": "multitoken",
"tokenId": "2605",
"metadataURI": "https://www.cryptovoxels.com/c/1/2605",
"metadata": {
"url": "https://www.cryptovoxels.com/c/1/2605",
"name": "Link Marine Helmet",
"description": "Chainlink Marine Helmet, give Sergey Nazarov your love."
}
}
]
}Changes
- info
added the new enum value
robinhood-mainnetto thequeryrequest parameterchain - info
added the new enum value
robinhood-testnetto thequeryrequest parameterchain
- info