GET
/
v0
/
pendle
/
market
Python (SDK)
from compass_api_sdk import CompassAPI, models


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

    res = compass_api.pendle.market(chain=models.PendleMarketChain.ARBITRUM_MAINNET, market_address="0x46d62a8dede1bf2d0de04f2ed863245cbba5e538")

    # Handle response
    print(res)
{
  "market_address": "<string>",
  "implied_apy": "<string>",
  "maturity_date": "2023-11-07T05:31:56Z",
  "tokens": {
    "underlying_token": {
      "address": "<string>",
      "symbol": "<string>",
      "name": "<string>",
      "decimals": 123
    },
    "sy": {
      "address": "<string>",
      "symbol": "<string>",
      "name": "<string>",
      "decimals": 123
    },
    "pt": {
      "address": "<string>",
      "symbol": "<string>",
      "name": "<string>",
      "decimals": 123
    },
    "yt": {
      "address": "<string>",
      "symbol": "<string>",
      "name": "<string>",
      "decimals": 123
    },
    "accounting_asset": {
      "address": "<string>",
      "symbol": "<string>",
      "name": "<string>",
      "decimals": 123
    }
  },
  "user_position": {
    "claimable_yield": "<string>",
    "sy_balance": "<string>",
    "pt_balance": "<string>",
    "yt_balance": "<string>",
    "lp_balance": "<string>",
    "underlying_token_balance": "<string>",
    "accounting_asset_balance": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

​
chain
enum<string>
default:arbitrum:mainnet
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
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:0xB7954A07213413b2ec6Faa1360f56a498eACe10b

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

200
application/json

Successful Response

The response is of type object.