BLblockdaemon
yieldaggregator

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)

post/defi/v1/yieldaggregator/withdrawvault

Request

  • Base URL
    https://svc.blockdaemon.com
  • URL
    https://svc.blockdaemon.com/defi/v1/yieldaggregator/withdrawvault
  • Auth
    API key in header X-API-Key

Request body

amountstring 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".

fromstring 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.

gasstring

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.

tokenAddressstring

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

vaultNumberstring

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.

vaultAddressstring

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.

yieldAggregatorId'5000' | '5001' | '5002' | '5003' | '5100'

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

gasPrioritystring

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

enableFeeboolean

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

poolAddressstring

Address of the liquidity pool.

Example request

{
  "amount": "1000000000000000000",
  "from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
  "gas": "100000",
  "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "vaultNumber": "1",
  "vaultAddress": "0xa258C4606Ca8206D8aA700cE2143D7db854D168c",
  "yieldAggregatorId": "5000",
  "gasPriority": "low",
  "enableFee": false,
  "poolAddress": "0xfad57d2039c21811c8f2b5d5b65308aa99d31559"
}

Response

Successful response

statusinteger
msgstring
dataobject

Example response

{
  "status": 200,
  "msg": "success",
  "data": {
    "chainId": "1",
    "from": "0x63056E00436Da25BcF48A40dfBbDcc7089351006",
    "to": "0xFE09e53A81Fe2808bc493ea64319109B5bAa573e",
    "value": "0",
    "gas": "2307200",
    "data": "0x2e1a7d4d000000000000000000000000000000000000000000000000000000000007a120",
    "referenceId": "7250fb68fbfa4411901e2a77b1e06974"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.