Redeem

Converts yield-bearing tokens back into their underlying asset within a yield aggregator protocol. The response includes transaction metadata (chain ID, addresses, gas) and a unique reference ID for tracking.

💡

Compute Unit Value: 40 (Fixed)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request body for a /defi/v1/yieldaggregator/redeem

The request body for a /defi/v1/yieldaggregator/redeem

string
enum

The unique identifier used to route queries or transactions to the correct yield aggregator.

Allowed:
string
required

The token to be received upon withdrawal.

string
required

Amount of the input token to provide, specified in the token's smallest denomination (base units). Do not send human-readable decimal values. Examples: to swap 1 WETH (18 decimals), use "1000000000000000000"; to swap 1 USDC (6 decimals), use "1000000".

string
required

Blockchain address of the sender. For EVM chains, use a checksummed hex address (e.g., 0xABCDEF...). This address must hold sufficient balance and will sign the transaction.

string

Maximum number of gas units to allocate for the transaction, as an integer string (e.g., '200000'). If omitted, gas is estimated automatically. Note: this is gas units, not wei or gwei.

string

Optional slippage tolerance for the transaction. Valid range: 0 to 100 (e.g., 1 = up to 1% slippage).

string
required

The blockchain address of the yield token. You can provide this parameter using either 'ytAddress' (yield token address) or 'syAddress' (standard yield address). Both names are accepted and refer to the same value.

string
required

The blockchain address of the yield token. You can provide this parameter using either 'ytAddress' (yield token address) or 'syAddress' (standard yield address). Both names are accepted and refer to the same value.

boolean

Flag to include a basis points fee transaction alongside the main transaction when set to true.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json