Skip to main content
GET
/
v2
/
tokenized_equities
/
positions
Python (SDK)
from compass_api_sdk import CompassAPI


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

    res = compass_api.tokenized_equities.tokenized_equities_positions(owner="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B")

    # Handle response
    print(res)
{
  "owner": "0x2ed5C9c14E1F8baA94CD3e9b5b6e3F8e3D27504F",
  "positions": [
    {
      "balance": "20.745964",
      "balance_usd": "7361.10",
      "contract_address": "0xf6b1117ec07684D3958caD8BEb1b302bfD21103f",
      "current_price_usd": "354.82",
      "decimals": 18,
      "name": "Tesla, Inc.",
      "symbol": "TSLAon",
      "underlying_ticker": "TSLA"
    },
    {
      "balance": "5.000000",
      "balance_usd": "1145.65",
      "contract_address": "0x6cdcF8C170552DCA1a4dD8Bb1aB6dB7e7E0bF7c4",
      "current_price_usd": "229.13",
      "decimals": 18,
      "name": "Apple Inc.",
      "symbol": "AAPLon",
      "underlying_ticker": "AAPL"
    }
  ],
  "total_usd": "8506.75"
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

​
owner
string
default:0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B
required

The address of the owner of the Tokenized Equities Account to get positions for. The account address is derived deterministically from this owner; balances are read from the derived account.

Response

Successful Response

On-chain tokenized-equity holdings for an owner's Tokenized Equities Account.

​
owner
string
required

Owner address from the request. Balances are read from the Tokenized Equities Account address derived from this owner.

​
total_usd
string
required

Sum of balance_usd across positions where the price is known.

​
positions
Position · object[]

Non-zero positions only; tokens with a zero balance are omitted.