POST
/
v0
/
uniswap
/
swap
/
sell_exactly
from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.uniswap_v3.swap_sell_exactly(token_in=models.TokenEnum.FXS, token_out=models.TokenEnum.LUSD, fee=models.FeeEnum.ZERO_DOT_05, amount_in=1.5, chain=models.Chain.ARBITRUM_MAINNET, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B", amount_out_minimum=1.4)

    # Handle response
    print(res)
{
  "chainId": 123,
  "data": "<string>",
  "from": "<string>",
  "gas": 123,
  "to": "<string>",
  "value": 123,
  "nonce": 123,
  "maxFeePerGas": 123,
  "maxPriorityFeePerGas": 123
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json

Request model for selling exactly an amount of tokens.

​
token_in
enum<string>
required

The symbol of the token to swap from.

Available options:
1INCH,
AAVE,
BAL,
cbBTC,
cbETH,
CRV,
crvUSD,
DAI,
ENS,
ETHx,
FRAX,
FXS,
GHO,
KNC,
LDO,
LINK,
LUSD,
MKR,
osETH,
PYUSD,
rETH,
RPL,
rsETH,
sDAI,
SNX,
STG,
sUSDe,
tBTC,
UNI,
USDC,
USDe,
USDS,
USDT,
WBTC,
weETH,
WETH,
wstETH,
ARB,
EURS,
MAI,
USDCe,
AERO,
EUR,
VIRTUAL
​
token_out
enum<string>
required

The symbol of the token to swap to.

Available options:
1INCH,
AAVE,
BAL,
cbBTC,
cbETH,
CRV,
crvUSD,
DAI,
ENS,
ETHx,
FRAX,
FXS,
GHO,
KNC,
LDO,
LINK,
LUSD,
MKR,
osETH,
PYUSD,
rETH,
RPL,
rsETH,
sDAI,
SNX,
STG,
sUSDe,
tBTC,
UNI,
USDC,
USDe,
USDS,
USDT,
WBTC,
weETH,
WETH,
wstETH,
ARB,
EURS,
MAI,
USDCe,
AERO,
EUR,
VIRTUAL
​
fee
enum<string>
required

The swap fee of the pool

Available options:
0.01,
0.05,
0.3,
1.0
​
amount_in
required

The amount of the token to swap from

Required range: x > 0
Examples:

1.5

​
chain
enum<string>
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
sender
string
required

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
amount_out_minimum
default:0

The minimum amount of the token to swap to, defaults to 0

Required range: x >= 0
Examples:

1.4

​
wrap_eth
boolean
default:false

Whether to wrap ETH to WETH, only use when swapping WETH into something

Examples:

true

Response

200
application/json
Successful Response
​
chainId
integer
required

The chain id of the transaction

​
data
string
required

The data of the transaction

​
from
string
required

The sender of the transaction

​
gas
integer
required

The gas of the transaction

​
to
string
required

The recipient of the transaction

​
value
integer
required

The value of the transaction

​
nonce
integer
required

The nonce of the address

​
maxFeePerGas
integer
required

The max fee per gas of the transaction

​
maxPriorityFeePerGas
integer
required

The max priority fee per gas of the transaction