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
amount
default:0.5
required

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

Required range: x > 0
Example:

1.5

unique_market_key
string
default:0x3b3769cfca57be2eaed03fcc5299c25691b77781a1e124e7a8d520eb9a7eabb5
required

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

Pattern: ^0x.*
Example:

"0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4"

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

"base"

sender
string
default:0x62e25C7CAADca07b5dFB6C52E01329451048632E
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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

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

callback_data
file | null

An optional field for callback byte data that will be triggered upon successful supplying of collateral.

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.

Example: