Allocate (multi-op batch)
POST/v1/actions/allocate
Bundles multiple lending and token operations into a single composer transaction. Useful for portfolio rebalances, atomic deposit-then-borrow flows, or wrap/unwrap + deposit combos that should not be split across separate user signatures.
Request body: { chainId, operator, actions[] }. Each actions[] entry is { type, params } where type is one of Deposit | Withdraw | Borrow | Repay | Transfer | Wrap | Unwrap | Sweep. The params shape is action-specific (asset, amount, market, etc.) — see the AllocationAction schema.
Response: a single composer-call payload (operations / data / value) ready to send to the composer contract, plus permissionTxns for any required ERC20 approvals or borrow delegations.
Returns 422 with field-level details if validation fails (unknown action type, missing required params, incompatible chain/lender combo).
Plain-text reference — POST /v1/actions/allocate
Request body
| Field | Type | Required | Description |
|---|---|---|---|
chainId | string | yes | EVM chain id, as a decimal string. See the ChainId schema. |
operator | string | yes | |
actions | object[] | yes | |
actions[].type | Deposit, Withdraw, Borrow, Repay, Transfer, Wrap, … (8 values) | yes | |
actions[].params | object | yes |
Response 200
| Field | Type | Description |
|---|---|---|
success | True | |
data | object | |
data.operations | string | |
data.data | string | Informational payload. null when the endpoint only builds calldata. |
data.value | string | Native-token value to send with the transaction, in wei. |
data.permissionTxns | object[] | Approvals needed for this specific quote. Most integrators should use the deduplicated envelope-level actions.permissions instead. |
data.permissionTxns[].to | string | Target contract address |
data.permissionTxns[].data | string | Encoded calldata |
data.permissionTxns[].value | string | ETH value |
data.permissionTxns[].description | string | Human-readable description of the approval (e.g. "Approve borrow for AAVE_V3", "Approve ERC20") |
data.permissionTxns[].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. |
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
{
"success": true,
"data": {
"operations": "string",
"data": "0x617ba037000000000000000000000000c02aaa39b2",
"value": "1000000000000000000",
"permissionTxns": [
{
"to": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"data": "0x617ba037000000000000000000000000c02aaa39b2",
"value": "0",
"description": "string",
"spender": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
}
]
},
"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"
}
]
}
}
Request
Responses
- 200
- 400
- 422
- 429
- 500
- 502
Allocation transaction
Validation error
Validation failed (e.g. unknown action type, missing required params)
Rate limited. Unauthenticated callers share a per-IP budget; send an x-api-key header to lift it. Retry with exponential backoff.
Unexpected server error. Safe to retry with backoff.
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.