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
token_out
enum<string>
default:USDC
required

The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.

Available options:
DAI,
USDC
Example:

"USDC"

amount
default:0.2
required

The amount of USDS you would like to sell 1:1 for 'token_out'.

Required range: x > 0
Example:

1.5

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

"ethereum"

sender
string
default:0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:SKY_SELL
Allowed value: "SKY_SELL"
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: