Skip to main content
POST
/
v1
/
morpho
/
withdraw_collateral
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_collateral(amount=1.5, unique_market_key="0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4", chain=models.MorphoWithdrawCollateralRequestChain.ARBITRUM, 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
amount
required

Amount of the token to supply to the market as collateral.

Required range: x > 0
Examples:

1.5

unique_market_key
string
required

The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.

Examples:

"0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4"

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

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:MORPHO_WITHDRAW_COLLATERAL
Allowed value: "MORPHO_WITHDRAW_COLLATERAL"
on_behalf_of
string | null

The address on behalf of whom the withdraw is made. Defaults to sender.

receiver
string | null

The address where the withdrawn collateral will be received. Defaults to 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