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)import { CompassApiSDK } from "@compass-labs/api-sdk";
const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await compassApiSDK.pendle.pendleRedeemYield({
marketAddress: "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
chain: "arbitrum",
sender: "0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126",
});
console.log(result);
}
run();curl --request POST \
--url https://api.compasslabs.ai/v1/pendle/redeem_yield \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"chain": "arbitrum",
"sender": "0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126",
"market_address": "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chain: 'arbitrum',
sender: '0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126',
market_address: '0x46d62a8dede1bf2d0de04f2ed863245cbba5e538'
})
};
fetch('https://api.compasslabs.ai/v1/pendle/redeem_yield', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.compasslabs.ai/v1/pendle/redeem_yield",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chain' => 'arbitrum',
'sender' => '0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126',
'market_address' => '0x46d62a8dede1bf2d0de04f2ed863245cbba5e538'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.compasslabs.ai/v1/pendle/redeem_yield"
payload := strings.NewReader("{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.compasslabs.ai/v1/pendle/redeem_yield")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compasslabs.ai/v1/pendle/redeem_yield")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}"
response = http.request(request)
puts response.read_body{
"transaction": {
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Pendle
Redeem Claimable Yield
Redeem claimable yield from the market’s associated Yield Token (YT).
Required Allowances
In order to make this transaction, token allowances need to be set for the following contracts.
PendleRouter
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)import { CompassApiSDK } from "@compass-labs/api-sdk";
const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await compassApiSDK.pendle.pendleRedeemYield({
marketAddress: "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
chain: "arbitrum",
sender: "0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126",
});
console.log(result);
}
run();curl --request POST \
--url https://api.compasslabs.ai/v1/pendle/redeem_yield \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"chain": "arbitrum",
"sender": "0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126",
"market_address": "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chain: 'arbitrum',
sender: '0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126',
market_address: '0x46d62a8dede1bf2d0de04f2ed863245cbba5e538'
})
};
fetch('https://api.compasslabs.ai/v1/pendle/redeem_yield', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.compasslabs.ai/v1/pendle/redeem_yield",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chain' => 'arbitrum',
'sender' => '0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126',
'market_address' => '0x46d62a8dede1bf2d0de04f2ed863245cbba5e538'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.compasslabs.ai/v1/pendle/redeem_yield"
payload := strings.NewReader("{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.compasslabs.ai/v1/pendle/redeem_yield")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compasslabs.ai/v1/pendle/redeem_yield")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chain\": \"arbitrum\",\n \"sender\": \"0xDB5282f99C964B2Cd72354fFf33Ad7eE482A0126\",\n \"market_address\": \"0x46d62a8dede1bf2d0de04f2ed863245cbba5e538\"\n}"
response = http.request(request)
puts response.read_body{
"transaction": {
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
The address of the market identifying which Yield Token (YT) you would like to claim yield from.
Example:
"0x08a152834de126d2ef83d612ff36e4523fd0017f"
Available options:
arbitrum, base, ethereum Example:
"arbitrum"
The address of the transaction sender.
Example:
"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
Allowed value:
"PENDLE_REDEEM_YIELD"Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
Response
Successful Response
The unsigned transaction data. User must sign and broadcast to network.
- UnsignedTransaction
- UserOperationResponse
Show child attributes
Show child attributes
Example:
{
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
Was this page helpful?
⌘I