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


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

    res = compass_api.morpho.morpho_withdraw(vault_address="0xc1256Ae5FF1cf2719D4937adb3bbCCab2E00A2Ca", amount="ALL", chain=models.MorphoWithdrawRequestChain.BASE, sender="0xB3B45f5aCBb58a432BDe58724c1C959E11D5A418", 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 withdrawing from.

Example:

"0xbEef047a543E45807105E51A8BBEFCc5950fcfBa"

amount
required

The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.

Example:

1.5

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

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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

The address which will receive the tokens withdrawn. 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
UnsignedTransaction · object
required

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