API ReferenceVaults

Build calldata to withdraw free liquidity from a vault

Returns the transaction calldata the LP signs and sends to withdraw their free (undeployed) principal from an asset vault. To exit deployed capital, use prepare-request-redeem instead.

Authorization

ApiKeyAuth

X-API-Key<token>

In: header

Path Parameters

chainId*string

Numeric ID of the chain to query or act on.

asset*string

The vault's underlying asset, as a token contract address (0x-prefixed).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Amount of free principal to withdraw, integer string in the asset's smallest unit.

owner*string

Position owner whose free principal is withdrawn (0x address).

receiver?string

Address to receive the withdrawn assets (0x address). Defaults to owner.

Response Body

`application/json`

curl -X POST "https://example.com/api/vaults/string/string/prepare-withdraw" \  -H "Content-Type: application/json" \  -d '{    "amount": "string",    "owner": "string"  }'

{  "vault": "string",  "calls": [    {      "to": "string",      "data": "string",      "value": "string",      "description": "string"    }  ],  "freePrincipal": "string"}

Empty

Build calldata to request an async redeem of deployed capital

Returns the calldata to open an ERC-7540 async redeem request, the exit for capital deployed into a strategy. It escrows the request, after which the composer strikes the price and prepare-claim-redeem pays out.

Everything one LP can act on for a chain, in one request

Returns every strategy class this LP backs, plus every class where they hold principal in a leg, each with its pair, strategist, per-leg capital, leave gates, and venue reach across Aqua and V4. Read-only. Figures that did not resolve are OMITTED rather than reported as zero.