Skip to main content
GET
Python (SDK)

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
block
integer | null

Optional block number (defaults to latest).

market_address
string
default:0x46d62a8dede1bf2d0de04f2ed863245cbba5e538
required

The market address of the desired position.

user_address
string | null
default:0x68C314e30b543a35819e5625da563E6Da65D5dd4

The user address of the desired market position. Only include if you would like the user position included in the response. Defaults to None.

Response

Successful Response

market_address
string
required

The address of the market.

implied_apy
string
required

The implied APY of the market.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
maturity_date
string<date-time>
required

The maturity date of the market. ISO 8601 format. UTC timezone.

tokens
MarketTokens · object
required

Token data relevant to the market.

user_position
UserPosition · object | null

The user's position in the market.