Skip to main content
GET
/
v2
/
credit
/
balances
Python (SDK)
from compass_api_sdk import CompassAPI, models


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

    res = compass_api.credit.credit_balances(chain=models.V2CreditBalancesChain.BASE, owner="0x01E62835dd7F52173546A325294762143eE4a882")

    # Handle response
    print(res)
{
  "credit_account_address": "<string>",
  "balances": {
    "USDC": {
      "balance": "70710737",
      "balance_formatted": "70.710737",
      "token_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "token_decimals": 6,
      "token_symbol": "USDC",
      "transfers": [
        {
          "amount": "70710737",
          "amount_formatted": "70.710737",
          "block_number": 43830869,
          "block_timestamp": "2026-03-25T15:04:45Z",
          "direction": "in",
          "from_address": "0x111111125421cA6dc452d289314280a0f8842A65",
          "to_address": "0x4d4eb02B8d86379C36E887f391a039a17D72d9E0",
          "transaction_hash": "0x949969bf49c100beca5d05bebbc99a57608a6d1f7472c621f3b00a5987bb417a"
        }
      ],
      "usd_value": "70.77"
    },
    "WETH": {
      "balance": "876484654169830",
      "balance_formatted": "0.000876",
      "token_address": "0x4200000000000000000000000000000000000006",
      "token_decimals": 18,
      "token_symbol": "WETH",
      "transfers": [
        {
          "amount": "876484654169830",
          "amount_formatted": "0.000876",
          "block_number": 43482380,
          "block_timestamp": "2026-03-17T13:28:27Z",
          "direction": "in",
          "from_address": "0xd4a0e0b9149bcee3c920d2e00b5de09138fd8bb7",
          "to_address": "0x4d4eb02B8d86379C36E887f391a039a17D72d9E0",
          "transaction_hash": "0x4165f6f2185375050f39413833e7a77f33c9c4afd429acec0d867315d96b2ea4"
        }
      ],
      "usd_value": "1.80"
    }
  },
  "total_usd_value": "72.57"
}

Documentation Index

Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

​
chain
enum<string>
default:base
required
Available options:
arbitrum,
base,
ethereum
​
owner
string
default:0x01E62835dd7F52173546A325294762143eE4a882
required

The address of the owner of the credit account.

Response

Successful Response

Response containing credit account balances and transfer history.

​
credit_account_address
string
required

The derived credit account address.

Example:

"0x4d4eb02B8d86379C36E887f391a039a17D72d9E0"

​
balances
Balances · object

Token balances keyed by token symbol.

Example:
{
  "USDC": {
    "balance": "70710737",
    "balance_formatted": "70.710737",
    "token_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "token_decimals": 6,
    "token_symbol": "USDC",
    "transfers": [
      {
        "amount": "70710737",
        "amount_formatted": "70.710737",
        "block_number": 43830869,
        "block_timestamp": "2026-03-25T15:04:45Z",
        "direction": "in",
        "from_address": "0x111111125421cA6dc452d289314280a0f8842A65",
        "to_address": "0x4d4eb02B8d86379C36E887f391a039a17D72d9E0",
        "transaction_hash": "0x949969bf49c100beca5d05bebbc99a57608a6d1f7472c621f3b00a5987bb417a"
      }
    ],
    "usd_value": "70.77"
  },
  "WETH": {
    "balance": "876484654169830",
    "balance_formatted": "0.000876",
    "token_address": "0x4200000000000000000000000000000000000006",
    "token_decimals": 18,
    "token_symbol": "WETH",
    "transfers": [
      {
        "amount": "876484654169830",
        "amount_formatted": "0.000876",
        "block_number": 43482380,
        "block_timestamp": "2026-03-17T13:28:27Z",
        "direction": "in",
        "from_address": "0xd4a0e0b9149bcee3c920d2e00b5de09138fd8bb7",
        "to_address": "0x4d4eb02B8d86379C36E887f391a039a17D72d9E0",
        "transaction_hash": "0x4165f6f2185375050f39413833e7a77f33c9c4afd429acec0d867315d96b2ea4"
      }
    ],
    "usd_value": "1.80"
  }
}
​
total_usd_value
string | null

Total USD value of all balances (sum of available values).

Example:

"72.57"