Withdraw Vault

Executes withdrawals from yield vaults, returning the user’s deposited tokens. Multiple identification methods (vaultAddress, tokenAddress, vaultNumber) are supported, with transaction details provided for verification and 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/withdrawvault

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

string
required

Number of tokens, specified in the token's smallest denomination (base units). Do not send human-readable decimal values. Examples: 1 WETH (18 decimals) = "1000000000000000000"; 1 USDC (6 decimals) = "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

The smart contract address of the token. Use this parameter along with vaultNumber if you are not providing the vaultAddress directly.

string

A numeric identifier for the specific vault (used when there are multiple vaults for the same token). Provide this along with tokenAddress if vaultAddress is not available.

string

The direct blockchain address of the yield vault to withdraw from. Use this parameter if you wish to directly specify the target vault instead of using tokenAddress and vaultNumber.

string
enum

The unique ID to specify the yield aggregator for queries or transactions.

Allowed:
string

Specifies the priority level for gas fees (e.g., 'low', 'medium', or 'high'), which influences the transaction speed and cost.

boolean

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

string

Address of the liquidity pool.

Response

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