Skip to main content
POST
/
v1
/
pendle
/
redeem_yield
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.pendle_redeem_yield(market_address="0x46d62a8dede1bf2d0de04f2ed863245cbba5e538", chain=models.PendleRedeemYieldRequestChain.ARBITRUM, sender="0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126", estimate_gas=True)

    # Handle response
    print(res)
{
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json
​
market_address
string
required

The address of the market identifying which Yield Token (YT) you would like to claim yield from.

Example:

"0x08a152834de126d2ef83d612ff36e4523fd0017f"

​
chain
enum<string>
required
Available options:
arbitrum,
base,
ethereum
​
sender
string
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
action_type
string
default:PENDLE_REDEEM_YIELD
Allowed value: "PENDLE_REDEEM_YIELD"
​
estimate_gas
boolean
default:true

Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.

Response

Successful Response

​
transaction
UnsignedTransaction · object
required

The unsigned transaction data. User must sign and broadcast to network.