Skip to main content
GET
/
v1
/
token
/
balance
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.token.token_balance(chain=models.V1TokenBalanceChain.ARBITRUM, user="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B", token="USDC")

    # Handle response
    print(res)
{
  "amount": 1.5,
  "decimals": 18,
  "token_symbol": "<string>",
  "token_address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

chain
enum<string>
default:arbitrum
required
Available options:
arbitrum,
base,
ethereum
user
string
default:0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B
required

The user to get the token balance of.

token
string
default:USDC
required

The symbol or address of the token for which the balance is checked.

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

Response

Successful Response

Response model for token balance information.

amount
string
required

Amount of tokens a particular address holds

Examples:

1.5

decimals
integer
required

Number of decimals of the token

Examples:

18

token_symbol
string
required

Symbol of the token

token_address
string
required

Address of the token

Examples:

"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"