Balances
Access realtime token balances. Get comprehensive details about native and ERC20 tokens, including token metadata and USD valuations.
The Token Balances API provides accurate and fast real time balances of the native and ERC20 tokens of accounts on supported EVM blockchains.
The Balances API only returns balances for certain low latency chains by default.
To fetch balances for all supported chains, use the ?chains_ids=all
query parameter.
Token Prices
Sim looks up prices onchain. We use the most liquid onchain pair to determine a USD price. We return the available liquidity in pool_size
as part of the response, and show a warning low_liquidity: true
if this value is less than $10k.
Spam Tokens
The Balances API provides the ?exclude_spam_tokens
query parameter. You can use it filter out potential spam tokens based on various criteria, including a minimum liquidity threshold of $100.
We also include the pool_size
field in all responses, allowing you to implement custom filtering logic based on your specific requirements. For a detailed explanation of our spam filtering approach, see our Spam Token Filtering guide.
Pagination
This endpoint is using cursor based pagination. You can use the limit
query parameter to define the maximum page size.
Results might at times be less than the maximum page size.
The next_offset
value is passed back by the initial response and can be used to fetch the next page of results, by passing it as the offet
query parameter in the next request.
You can only use the value from next_offset
to set the offset
query parameter of the next page of results.
Headers
API key to access the service
Path Parameters
Wallet to get balances for
Query Parameters
A comma separated list of chain_ids or tags for blockchains to get balances for. Examples: chain_ids=1,8453,10, chain_ids=mainnet,testnet. Only balances for blockchains tagged with all the specified tags are returned. Please see the response of the /chains endpoint for the tags on each blockchain.
Specify this to exclude spam tokens from the response
Specify erc20
or native
to get only ERC20 tokens or native assets, respectively
erc20
, native
A comma separated list of additional metadata fields to include for each token. Supported values: logo
, url
The offset to paginate through result sets. This is a cursor being passed from the previous response, only use what the backend returns here.
Maximum number of transactions to return
x >= 0
Response
Successful Response
The response is of type object
.