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.2
required

The amount of USDS you would like to deposit for sUSDS to earn yield.

Required range: x > 0
Example:

1.5

sender
string
default:0x7F6063e2237a6b2aE32eDc48EF9cD1B2A8F3aD5D
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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

The address which will receive the sUSDS. Defaults to the sender.

chain
enum<string>
default:ethereum
Available options:
ethereum
Example:

"ethereum"

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: