Skip to main content
POST
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json

Request model for the unified manage endpoint.

Inherits from EarnManageParams and adds context fields (owner, chain, etc).

venue
VaultVenue · object
required

The earn venue.

Example:
action
enum<string>
default:DEPOSIT
required

Whether you are depositing into or withdrawing from the given Earn venue.

Available options:
DEPOSIT,
WITHDRAW
Example:

"DEPOSIT"

amount
default:0.01
required

Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset; for PENDLE_PT, this is the amount of token to spend (DEPOSIT) or PT to sell (WITHDRAW); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0.

Required range: x > 0
Example:

0.1

owner
string
default:0x06A9aF046187895AcFc7258450B15397CAc67400
required

The primary wallet address that owns and controls the Earn Account.

Example:

"0x06A9aF046187895AcFc7258450B15397CAc67400"

chain
enum<string>
default:base
required

Blockchain network

Available options:
arbitrum,
base,
bsc,
ethereum,
hyperevm,
tempo
Example:

"base"

action_type
string
default:V2_MANAGE

Action type identifier for manage operations.

Allowed value: "V2_MANAGE"
fee
Fee · object | null

Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount, as a fixed token amount, or as a percentage of realized profit (PERFORMANCE).

gas_sponsorship
boolean
default:false

Optionally request gas sponsorship. If set to true, EIP-712 typed data will be returned that must be signed by the owner and submitted to the 'Prepare gas-sponsored transaction' endpoint (/gas_sponsorship/prepare).

Example:

false

Response

Successful Response

transaction
UnsignedTransaction · object | null

Unsigned transaction for direct execution. Present when gas_sponsorship=false.

Example:
eip_712
BatchedSafeOperationsResponse · object | null

EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.

Example:
settlement
enum<string>
default:instant

'instant' when the action completes in this transaction. 'async' for a MAPLE WITHDRAW: the transaction only requests the redemption from Maple's withdrawal queue, and the underlying asset arrives in the product account when Maple processes the queue (typically within minutes, at most 30 days). Until then the position shows a pending_redemption.

Available options:
instant,
async
estimated_amount_out
string | null

For an async withdrawal, the underlying asset expected at today's exit rate. Maple pays at the rate when it processes the request, so this is an estimate. Null for instant actions.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
poll_endpoint
string | null

For an async withdrawal, the endpoint that shows its progress. Null for instant actions.