- These endpoints are authenticated with a normal Sim API key.
- Specify
?chains=solana,eclipse
to fetch balances only for select chains. - Token metadata includes symbols, decimals, and price information when available.
Response Structure
The API returns a JSON object with the following top-level fields:Field | Description | Type |
---|---|---|
processing_time_ms | Time taken to process the request in milliseconds | number |
wallet_address | The queried wallet address | string |
next_offset | Pagination token for the next page of results | string/null |
balances_count | Total number of balances returned | number |
balances | Array of token balance objects | array |
Balance Object Fields
Each item in thebalances
array contains the following fields:
Field | Description | Type |
---|---|---|
chain | Name of blockchain of token | string |
address | Token contract address or blockchain name for native token | string |
amount | Amount of token owned in smallest unit | string |
balance | Formatted amount with decimals applied | string |
value_usd | Current value of token owned, if available | number |
program_id | Program ID of the token (for SPL tokens) | string |
decimals | Decimals of token | number |
total_supply | Total supply of the token | string |
name | Name of token | string |
symbol | Symbol of token | string |
uri | URI to token metadata | string |
price_usd | Current price of token, if available | number |
liquidity_usd | Liquidity in USD, if available | number/null |
pool_type | Type of liquidity pool, if available | string/null |
pool_address | Address of liquidity pool, if available | string/null |
mint_authority | Mint authority address, if available | string/null |
Pagination
This endpoint is using cursor based pagination. You can use thelimit
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 offset
query parameter in the next request.
You can only use the value from
next_offset
to set the offset
parameter of the next page of results. Using your own offset
value will not have any effect.Headers
API key to access the service
Path Parameters
SVM address
Query Parameters
Comma-separated list of chains to include
Maximum number of results to return. Default is 1000 when not provided. Values above 1000 are reduced to 1000.
Required range:
1 <= x <= 1000
Pagination offset from previous response
Response
Successful response
The queried wallet address
Array of token balance objects
Time taken to process the request in milliseconds
Pagination token for the next page of results
Total number of balances returned