Skip to main content
POST
/
v1
/
vaults
/
deposit
Python (SDK)
from compass_api_sdk import CompassAPI, models


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

    res = compass_api.erc_4626_vaults.vaults_deposit(vault_address="0xbEef047a543E45807105E51A8BBEFCc5950fcfBa", amount=1.5, chain=models.VaultDepositRequestChain.ETHEREUM, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B", estimate_gas=True)

    # Handle response
    print(res)
{
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json
vault_address
string
required

The vault address you are depositing to.

Examples:

"0xbEef047a543E45807105E51A8BBEFCc5950fcfBa"

amount
required

The amount of tokens to deposit into the vault.

Required range: x > 0
Examples:

1.5

chain
enum<string>
required
Available options:
arbitrum,
base,
ethereum
sender
string
required

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:VAULT_DEPOSIT
Allowed value: "VAULT_DEPOSIT"
receiver
string | null

The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender.

estimate_gas
boolean
default:true

Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.

Response

Successful Response

transaction
object
required

The unsigned transaction data. User must sign and broadcast to network.

  • UnsignedTransaction
  • UserOperationResponse