Skip to main content

ActionSet

Transaction calldata and required approvals returned by action endpoints.

transactions object[]required

Pre-trade setup transactions (e.g. e-mode switch, collateral enable). Execute these before the main swap. Empty when no setup is needed.

  • Array [
  • chainTypestring

    Which VM executes this step. ABSENT means evm, which is the only value any endpoint returns today — every EVM response is unchanged. A non-EVM chain would return a different shape (a serialized, PERISHABLE transaction rather than to/data/value) carrying its own chainType, so a client that wants to stay forward-compatible should branch on this field rather than assume to is present.

    Possible values: [evm]

    tostringrequired

    Target contract address

    Example: 0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2
    datastringrequired

    Encoded calldata

    Example: 0x617ba037000000000000000000000000c02aaa39b2
    valuestringrequired

    ETH value to send with the transaction

    Example: 0
    descriptionstring

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

  • ]
  • 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.

  • Array [
  • chainTypestring

    Which VM executes this step. ABSENT means evm, which is the only value any endpoint returns today — every EVM response is unchanged. A non-EVM chain would return a different shape (a serialized, PERISHABLE transaction rather than to/data/value) carrying its own chainType, so a client that wants to stay forward-compatible should branch on this field rather than assume to is present.

    Possible values: [evm]

    tostringrequired

    Target contract address

    Example: 0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2
    datastringrequired

    Encoded calldata

    Example: 0x617ba037000000000000000000000000c02aaa39b2
    valuestringrequired

    ETH value to send with the transaction

    Example: 0
    descriptionstring

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

  • ]
  • permissions object[]nullable

    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.

  • Array [
  • tostringrequired

    Target contract address

    datastringrequired

    Encoded calldata

    valuestringrequired

    ETH value

    Example: 0
    descriptionstring

    Human-readable description of the approval (e.g. "Approve borrow for AAVE_V3", "Approve ERC20")

    spenderstring

    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.

    typestring

    What kind of grant this is. A signatures[] offer names the type it replaces via its replaces field.

    Possible values: [ERC20, Lender]

  • ]
  • signatures object[]

    EIP-712 payloads the user can sign INSTEAD of sending the corresponding permissions entry. Only present when the caller opted in with permit=auto|required and a permit path exists. Sign with eth_signTypedData_v4, then POST the same endpoint with {permits: [{permitId, signature}]} (plus builds where the response issued buildIds) — the permit executes inside the main transaction.

  • Array [
  • permitIdstringrequired

    Opaque, self-describing handle for this permit. Round-trip it verbatim: POST {permits: [{permitId, signature}]} back to the same endpoint.

    kindstringrequired

    Permit flavour

    Possible values: [erc2612, dai, permit2, aaveCredit, morphoAuth, cometAuth]

    typedData objectrequired

    Ready for eth_signTypedData_v4 (domain, types incl. EIP712Domain, primaryType, message). All numeric fields are decimal strings.

    property name*any

    Ready for eth_signTypedData_v4 (domain, types incl. EIP712Domain, primaryType, message). All numeric fields are decimal strings.

    replacesstringrequired

    Which permissions entry this signature replaces (ERC20 | Lender)

    spenderstring

    Who the signature authorises. Match against the permission / quote (approvalTarget) it replaces — on multi-spender responses (x-chain) only routes whose approvalTarget equals this spender are covered by the signature.

    descriptionstringrequired

    Human-readable label for this entry.

    unscopedbooleanrequired

    True when the grant is NOT amount-scoped (full position control until revoked) — surface this to the user.

    deadlinestringrequired

    Unix seconds after which the signature is worthless (default: 30 minutes).

  • ]
  • signs object[]

    Messages that MUST be signed before anything can be sent (unlike signatures, which are optional permit offers). When non-empty, transactions and alternatives are EMPTY: sign typedData with eth_signTypedData_v4 (or, for format: personal_sign, message with personal_sign), then call submit with the signature under submit.signatureField, and execute what that answers. permissions may still be present and can be sent before or after signing. Produced by Inverse FiRM loops (/loop/leverage, /loop/close), Morpho Midnight make, Term order-sign and the Lista leg of /rewards/claim.

  • Array [
  • purposestringrequired

    authorize-action: the signature authorises an on-chain action and submit answers its transaction (Inverse ALE loops). publish-order: the signature makes an off-chain order and submit publishes it (Midnight make, Term order-sign). authenticate: the signature is a LOGIN to a third-party API that serves the data the transaction needs (Lista reward proofs); it authorises nothing on-chain.

    Possible values: [authorize-action, publish-order, authenticate]

    formatstringrequired

    eip712: sign typedData with eth_signTypedData_v4. personal_sign: sign the UTF-8 message with personal_sign.

    Possible values: [eip712, personal_sign]

    typedData object

    format: eip712 only. Ready for eth_signTypedData_v4. All numeric fields are decimal strings.

    property name*any

    format: eip712 only. Ready for eth_signTypedData_v4. All numeric fields are decimal strings.

    messagestring

    format: personal_sign only. The exact text to sign; send it back verbatim (it is part of submit.params).

    signerstringrequired

    The address that must sign. The server recovers the signer and refuses any other.

    deadlinestring

    Unix seconds after which the signature is worthless.

    spenderstring

    Who the signature authorises.

    descriptionstringrequired

    Human-readable label for this entry.

    submit objectrequired
    methodstringrequired

    Possible values: [GET, POST]

    endpointstringrequired

    Path on this API, e.g. /v1/actions/loop/leverage.

    params object

    GET: the complete query to send — the original request plus the handle the signature is for (permitId). Replay verbatim.

    property name*string
    body object

    POST: the JSON body to send, verbatim.

    property name*any

    POST: the JSON body to send, verbatim.

    signatureFieldstringrequired

    The query param (GET) or body field (POST) that carries the signature.

  • ]
  • permitSkipped object[]

    Why a permit was NOT offered for a permission, when one was asked for (permit=auto|required). The corresponding approve transaction stands.

  • Array [
  • replacesstringrequired

    Which permission kind stays a transaction (ERC20 | Lender)

    reasonstringrequired
  • ]
  • ActionSet
    {
    "transactions": [
    {
    "chainType": "evm",
    "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
    "data": "0x617ba037000000000000000000000000c02aaa39b2",
    "value": "0",
    "description": "string"
    }
    ],
    "alternatives": [
    {
    "chainType": "evm",
    "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
    "data": "0x617ba037000000000000000000000000c02aaa39b2",
    "value": "0",
    "description": "string"
    }
    ],
    "permissions": [
    {
    "to": "string",
    "data": "string",
    "value": "0",
    "description": "string",
    "spender": "string",
    "type": "ERC20"
    }
    ],
    "signatures": [
    {
    "permitId": "string",
    "kind": "erc2612",
    "typedData": {},
    "replaces": "string",
    "spender": "string",
    "description": "string",
    "unscoped": true,
    "deadline": "string"
    }
    ],
    "signs": [
    {
    "purpose": "authorize-action",
    "format": "eip712",
    "typedData": {},
    "message": "string",
    "signer": "string",
    "deadline": "string",
    "spender": "string",
    "description": "string",
    "submit": {
    "method": "GET",
    "endpoint": "string",
    "params": {},
    "body": {},
    "signatureField": "string"
    }
    }
    ],
    "permitSkipped": [
    {
    "replaces": "string",
    "reason": "string"
    }
    ]
    }