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


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

    res = compass_api.global_markets_perps.global_markets_perps_opportunities(sort_by=models.GlobalMarketsPerpsSortBy.VOLUME_24H, sort_order=models.GlobalMarketsPerpsSortOrder.DESC)

    # Handle response
    print(res)
{
  "opportunities": [
    {
      "asset": "AAPL",
      "asset_id": 12,
      "category": "stock",
      "funding_rate": "0.0000125",
      "mark_price": "213.88",
      "max_leverage": 5,
      "open_interest": "8421530.50",
      "oracle_price": "213.80",
      "sz_decimals": 2,
      "volume_24h": "12498230.75"
    },
    {
      "asset": "GOLD",
      "asset_id": 3,
      "category": "commodity",
      "funding_rate": "-0.0000040",
      "mark_price": "2438.20",
      "max_leverage": 10,
      "open_interest": "5102330.10",
      "oracle_price": "2438.05",
      "sz_decimals": 3,
      "volume_24h": "9874120.40"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

min_open_interest
number | null

Filter by minimum open interest in USD

min_volume_24h
number | null

Filter by minimum 24h volume in USD

category
enum<string> | null

Filter by asset category: stock, commodity, forex

Available options:
stock,
commodity,
forex
sort_by
enum<string>
default:volume_24h

Sort results by this field

Available options:
open_interest,
volume_24h,
funding_rate
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

Successful Response

List of available global markets perps markets.

opportunities
GlobalMarketsPerpsOpportunity · object[]
required

Available global markets perps markets