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:ALL
required

The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.

Example:

"ALL"

sender
string
default:0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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

The address which will receive the withdrawn USDS. 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: