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


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

    res = compass_api.universal.generic_portfolio(chain=models.V1GenericPortfolioChain.ARBITRUM, user="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B")

    # Handle response
    print(res)
{
  "total_value_in_usd": "<string>",
  "token_balances": [
    {
      "amount": "<string>",
      "decimals": 123,
      "token_symbol": "<string>",
      "token_address": "<string>",
      "price": "<string>",
      "token_value_in_usd": "<string>"
    }
  ]
}

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

The user to get portfolio for.

Response

Successful Response

total_value_in_usd
string
required

Total value of the portfolio in USD

Example:

10000

token_balances
TokenBalance · object[]
required

List of token balances in the portfolio