POST
/
v0
/
morpho
/
withdraw_collateral
from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.morpho.withdraw_collateral(amount=1.5, unique_market_key="0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4", chain=models.Chain.ARBITRUM_MAINNET, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B")

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

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

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
sender
string
required

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
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.

Response

200
application/json
Successful Response
​
chainId
integer
required

The chain id of the transaction

​
data
string
required

The data of the transaction

​
from
string
required

The sender of the transaction

​
gas
integer
required

The gas of the transaction

​
to
string
required

The recipient of the transaction

​
value
integer
required

The value of the transaction

​
nonce
integer
required

The nonce of the address

​
maxFeePerGas
integer
required

The max fee per gas of the transaction

​
maxPriorityFeePerGas
integer
required

The max priority fee per gas of the transaction