# Vault withdraw (with caller-supplied share balance)

Endpoint reference for the 1delta API. Index: https://docs.1delta.io/llms.txt · every endpoint: https://docs.1delta.io/llms-full.txt

---

### POST /v1/actions/vaults/withdraw

- operationId: `vault-withdraw-with-caller-supplied-share-balance`
- docs: https://docs.1delta.io/1delta-api/vault-withdraw-with-caller-supplied-share-balance/
- markdown: https://docs.1delta.io/1delta-api/vault-withdraw-with-caller-supplied-share-balance.md
- tags: Vaults (Actions)

Vault withdraw (with caller-supplied share balance)

POST variant for `isAll=true` when the worker can't read the operator's share balance against its own RPC — fork tests, custom RPCs, sandbox endpoints. Same query params as GET; the body supplies the balance.

When `isAll=true` the worker treats the body's `sharesRaw` as the truth and encodes `vault.redeem(sharesRaw, receiver, operator)`. The query `amount` is ignored on this path.

When `isAll` is omitted/false the body is ignored (caller's `amount` is authoritative) — POST and GET behave identically.

**Parameters**

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `chainId` | query | string | yes | Chain ID See the `ChainId` schema for the full set of supported chains. |
| `vault` | query | string | yes | ERC-4626 share-token address |
| `underlying` | query | string | yes | Vault's `asset()` |
| `amount` | query | string | yes | Ignored when `isAll=true` is set. Otherwise: amount in wei (assets unless `isShares=true`). |
| `operator` | query | string | yes | User wallet (share holder) |
| `receiveAsset` | query | string | no | Underlying token to receive. Defaults to `underlying`. |
| `receiver` | query | string | no | Final recipient. Defaults to `operator`. |
| `isShares` | query | boolean | no | When `true`, `amount` is shares (ignored if `isAll=true`). |
| `isAll` | query | boolean | no | Full-balance withdraw. Body must include `sharesRaw`. |
| `mode` | query | "auto" \| "direct" \| "proxy" | no | Same as GET — execution mode selector. |

**Request body** (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sharesRaw` | string | yes | Operator's current vault-share balance as a decimal uint string. The worker uses this directly as the redeem amount. |

**Example request body**

```json
{
  "sharesRaw": "993566017"
}
```

**Response `200`** — Transaction calldata + any approval(s) needed for the vault withdraw

| Field | Type | Description |
| --- | --- | --- |
| `success` | true |  |
| `data` | object | Informational data (quotes, simulation results, etc.) |
| `actions` | object | Transaction calldata and approvals. Null for quote-only responses (no account provided). |
| `actions.transactions` | object[] | Pre-trade setup transactions (e.g. e-mode switch, collateral enable). Execute these before the main swap. Empty when no setup is needed. |
| `actions.transactions[].to` | string | Target contract address |
| `actions.transactions[].data` | string | Encoded calldata |
| `actions.transactions[].value` | string | ETH value to send with the transaction |
| `actions.transactions[].description` | string | Human-readable label. For `alternatives`, this is the aggregator name (e.g. "Paraswap"). For `transactions`, describes the setup action (e.g. "Switch e-mode to 1"). |
| `actions.alternatives` | object[] | DEX aggregator swap transactions sorted by best output (descending). Each entry's `description` is the aggregator name. The client should pick one to execute. Present on loop action endpoints. |
| `actions.alternatives[].to` | string | Target contract address |
| `actions.alternatives[].data` | string | Encoded calldata |
| `actions.alternatives[].value` | string | ETH value to send with the transaction |
| `actions.alternatives[].description` | string | Human-readable label. For `alternatives`, this is the aggregator name (e.g. "Paraswap"). For `transactions`, describes the setup action (e.g. "Switch e-mode to 1"). |
| `actions.permissions` | object[] | Approval/delegation transactions that must execute before both `transactions` and `alternatives`. Includes ERC20 allowances (targeting the composer contract) and lender borrow/withdrawal delegations (targeting the lending protocol contract directly). Filtered against on-chain state so only missing approvals are returned. Null when no approvals are needed. |
| `actions.permissions[].to` | string | Target contract address |
| `actions.permissions[].data` | string | Encoded calldata |
| `actions.permissions[].value` | string | ETH value |
| `actions.permissions[].description` | string | Human-readable description of the approval (e.g. "Approve borrow for AAVE_V3", "Approve ERC20") |
| `actions.permissions[].spender` | string | ERC-20 approve spender (x-chain permissions). Match it against the selected quote's `approvalTarget` — several bridges can share one spender, so do not match by description. |

**Example response**

```json
{
  "success": true,
  "data": {},
  "actions": {
    "transactions": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "alternatives": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "permissions": [
      {
        "to": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string",
        "spender": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
      }
    ]
  }
}
```

**Response `400`** — Validation error

**Response `429`** — Rate limited. Unauthenticated callers share a per-IP budget; send an `x-api-key` header to lift it. Retry with exponential backoff.

**Response `500`** — Unexpected server error. Safe to retry with backoff.

**Response `502`** — An upstream data source or protocol origin failed (`error.code` is `ORIGIN_FAILED`). `error.details` carries the per-origin status. This is also what a missing or malformed required parameter currently returns, rather than a 400.