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

Request model for buying exactly an amount of tokens.

token_in
string
default:USDC
required

The symbol of the token to swap from.

Example:

"WETH"

token_out
string
default:WETH
required

The symbol of the token to swap to.

Example:

"WETH"

tick_spacing
integer
default:100
required

The tick spacing of the pool

Required range: x >= 1
Examples:

100

300

400

500

1000

1500

2500

2700

3000

5000

6000

7000

8000

9000

10000

20000

amount_out
default:0.00001
required

The amount of the token to swap to

Required range: x > 0
Example:

1.5

amount_in_maximum
default:0.1
required

The maximum amount of the token to swap from

Required range: x >= 0
Example:

1.6

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

"base"

sender
string
default:0xA4C4fB06093C91E70528d4029050f358c4B065EE
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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