GET
https://api.compasslabs.ai
/
v0
/
pendle
/
position
from compass_api_sdk import CompassAPI, models


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

    res = compass_api.pendle.position(chain=models.PendlePositionChain.ETHEREUM_MAINNET, user_address="0xa829B388A3DF7f581cE957a95edbe419dd146d1B", market_address="0xdace1121e10500e9e29d071f01593fd76b000f08")

    # Handle response
    print(res)
{
  "claimable_yield": "<string>",
  "sy_balance": "<string>",
  "pt_balance": "<string>",
  "yt_balance": "<string>",
  "underlying_token_balance": "<string>",
  "underlying_token_name": "<string>",
  "underlying_token_symbol": "<string>",
  "maturity_date": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

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

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
block
default:latest

The block number you want to get this data at.

​
user_address
string
default:0xa829B388A3DF7f581cE957a95edbe419dd146d1B
required

The user address of the desired position.

​
market_address
string
default:0xdace1121e10500e9e29d071f01593fd76b000f08
required

The market address of the desired position.

Response

200
application/json

Successful Response

The response is of type object.