Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.earn.earn_bundle(owner="0x0B8A11cF0679F163087802c4428F640cA7C89926", chain=models.Chain.ETHEREUM, actions=[
        {
            "body": {
                "action_type": "V2_SWAP",
                "token_in": "USDC",
                "token_out": "AUSD",
                "amount_in": "100",
                "slippage": "0.5",
            },
        },
        {
            "body": {
                "action_type": "V2_MANAGE",
                "venue": {
                    "type": "VAULT",
                    "vault_address": "0x1B4cd53a1A8e5F50aB6320EF34E5fB4D3df7B6f6",
                },
                "action": models.EarnManageParamsAction.DEPOSIT,
                "amount": "ALL",
            },
        },
    ], gas_sponsorship=False)

    # Handle response
    print(res)

{
  "actions_count": 123,
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  },
  "eip_712": {
    "domain": {
      "chainId": 123,
      "verifyingContract": "<string>"
    },
    "types": {
      "EIP712Domain": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "SafeTx": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ]
    },
    "primaryType": "<string>",
    "message": {
      "to": "<string>",
      "value": "<string>",
      "data": "<string>",
      "operation": 0,
      "safeTxGas": "<string>",
      "baseGas": "<string>",
      "gasPrice": "<string>",
      "gasToken": "<string>",
      "refundReceiver": "<string>",
      "nonce": "<string>"
    }
  }
}

Earn

Execute multiple earn actions

This endpoint allows combining multiple actions (swaps, vault deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction executed via the Earn account).

Example Use Case: Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.

Actions are executed in the order they are provided. Each action type has its own parameters:

V2_SWAP: Swapping tokens within the Earn Account
V2_MANAGE: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool

The bundled transaction can be gas-sponsored by setting gas_sponsorship=true. This returns EIP-712 typed data that the owner must sign and submit to /gas_sponsorship/prepare for execution by a gas sponsor.

POST

earn

bundle

Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.earn.earn_bundle(owner="0x0B8A11cF0679F163087802c4428F640cA7C89926", chain=models.Chain.ETHEREUM, actions=[
        {
            "body": {
                "action_type": "V2_SWAP",
                "token_in": "USDC",
                "token_out": "AUSD",
                "amount_in": "100",
                "slippage": "0.5",
            },
        },
        {
            "body": {
                "action_type": "V2_MANAGE",
                "venue": {
                    "type": "VAULT",
                    "vault_address": "0x1B4cd53a1A8e5F50aB6320EF34E5fB4D3df7B6f6",
                },
                "action": models.EarnManageParamsAction.DEPOSIT,
                "amount": "ALL",
            },
        },
    ], gas_sponsorship=False)

    # Handle response
    print(res)

{
  "actions_count": 123,
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  },
  "eip_712": {
    "domain": {
      "chainId": 123,
      "verifyingContract": "<string>"
    },
    "types": {
      "EIP712Domain": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "SafeTx": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ]
    },
    "primaryType": "<string>",
    "message": {
      "to": "<string>",
      "value": "<string>",
      "data": "<string>",
      "operation": 0,
      "safeTxGas": "<string>",
      "baseGas": "<string>",
      "gasPrice": "<string>",
      "gasToken": "<string>",
      "refundReceiver": "<string>",
      "nonce": "<string>"
    }
  }
}

Authorizations

x-api-key

string

header

required

Your Compass API Key. Get your key here.

Body

application/json

owner

string

required

The owner's wallet address that controls the Earn Account.

chain

enum<string>

required

Target blockchain network where the bundled actions will execute.

Available options:

base,

ethereum,

arbitrum

actions

V2UserOperation · object[]

required

List of actions to bundle. Actions are executed in order.

Minimum array length: 1

Show child attributes

actions.body

EarnSwapParams · object

required

Parameters for swap operations (without context like owner/chain).

Used by multicall/bundle endpoint to specify swap actions.

EarnSwapParams
EarnManageParams

Show child attributes

actions.body.token_in

string

required

Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.

actions.body.token_out

string

required

Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.

actions.body.amount_in

required

Human-readable amount of token_in to swap (token units, not wei).

Required range: x > 0

Example:

1.5

actions.body.action_type

string

default:V2_SWAP

Action type identifier for swap operations.

Allowed value: "V2_SWAP"

actions.body.slippage

default:0.5

Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%).

Example:

0.5

gas_sponsorship

boolean

default:false

If true, returns EIP-712 typed data for gas sponsorship. The owner must sign this data and submit to /gas_sponsorship/prepare.

Response

Successful Response

actions_count

integer

required

Number of individual transactions bundled in this execution.

transaction

UnsignedTransaction · object

Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.

Show child attributes

transaction.chainId

string

required

The chain id of the transaction

transaction.data

string

required

The data of the transaction

transaction.from

string

required

The sender of the transaction

transaction.gas

string | null

required

The gas of the transaction

transaction.to

string

required

The recipient of the transaction

transaction.value

string

required

The value of the transaction

transaction.nonce

string

required

The nonce of the address

transaction.maxFeePerGas

string

required

The max fee per gas of the transaction

transaction.maxPriorityFeePerGas

string

required

The max priority fee per gas of the transaction

eip_712

BatchedSafeOperationsResponse · object

EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. Owner must sign and submit to /gas_sponsorship/prepare.

Show child attributes

eip_712.domain

EIP712Domain · object

required

EIP-712 domain separator

Show child attributes

eip_712.domain.chainId

integer

required

Chain ID for the Safe transaction

eip_712.domain.verifyingContract

string

required

Address of the Safe contract

eip_712.types

EIP712Types · object

required

EIP-712 type definitions

Show child attributes

eip_712.types.EIP712Domain

EIP712DomainField · object[]

required

EIP712Domain type definition

Show child attributes

eip_712.types.EIP712Domain.name

string

required

eip_712.types.EIP712Domain.type

string

required

eip_712.types.SafeTx

SafeTxField · object[]

required

SafeTx type definition

Show child attributes

eip_712.types.SafeTx.name

string

required

eip_712.types.SafeTx.type

string

required

eip_712.primaryType

string

required

Primary type for the structured data

Allowed value: "SafeTx"

eip_712.message

SafeTxMessage · object

required

Safe transaction message data

Show child attributes

eip_712.message.to

string

required

Destination address

eip_712.message.value

string

required

Value in wei as a string

eip_712.message.data

string

required

Transaction data as hex string

eip_712.message.operation

enum<integer>

required

Operation type (0=Call, 1=DelegateCall)

Available options:

0,

1

eip_712.message.safeTxGas

string

required

Gas for the Safe transaction

eip_712.message.baseGas

string

required

Base gas costs

eip_712.message.gasPrice

string

required

Gas price

eip_712.message.gasToken

string

required

Token address for gas payment

eip_712.message.refundReceiver

string

required

Address to receive gas refund

eip_712.message.nonce

string

required

Safe transaction nonce

Swap tokens within Earn Account Initiate USDC bridging

⌘I

API Reference

Authorizations

Body

Response