POST
/
v0
/
generic
/
portfolio
/
get
curl --request POST \
  --url https://api.compasslabs.ai/v0/generic/portfolio/get \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "user": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
}'
{
  "total_value_in_usd": 10000,
  "token_balances": [
    {
      "amount": 1.5,
      "decimals": 18,
      "token_symbol": "WETH",
      "token_address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
      "price": 2000,
      "token_value_in_usd": 2000
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Compass API key. Get your key here.

Body

application/json
chain
enum<string>
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
user
string
required

The address of the user.

Example:

"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45"

Response

200
application/json
Successful Response
total_value_in_usd
string
required

Total value of the portfolio in USD

Example:

10000

token_balances
object[]
required

List of token balances in the portfolio

Was this page helpful?