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


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

    res = compass_api.global_markets_perps.global_markets_perps_positions(owner="0x01E62835dd7F52173546A325294762143eE4a882")

    # Handle response
    print(res)
{
  "positions": [
    {
      "asset": "<string>",
      "asset_id": 123,
      "side": "long",
      "size": "<string>",
      "entry_price": "<string>",
      "mark_price": "<string>",
      "unrealized_pnl": "<string>",
      "leverage": "<string>",
      "margin_used": "<string>",
      "funding_accrued": "<string>",
      "liquidation_price": "<string>"
    }
  ],
  "account_value": "0",
  "withdrawable": "0"
}

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

​
owner
string
default:0x01E62835dd7F52173546A325294762143eE4a882
required

User's EOA address (looks up their global markets perps product account)

​
asset
string | null

Filter to a specific asset ticker (e.g. AAPL)

Response

Successful Response

List of open global markets perps positions with account balance.

​
positions
GlobalMarketsPerpsPosition · object[]
required

Open perpetual futures positions

​
account_value
string
default:0

Total account value in USD (margin + unrealized PnL)

​
withdrawable
string
default:0

Available USDC balance (withdrawable margin)