POST
/
v0
/
uniswap
/
swap
/
buy_exactly
curl --request POST \
  --url https://api.compasslabs.ai/v0/uniswap/swap/buy_exactly \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "sender": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
  "token_in": "USDC",
  "token_out": "USDT",
  "fee": "0.01",
  "amount_out": 1,
  "amount_in_maximum": 1.1,
  "wrap_eth": false
}'
{
  "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 buying exactly an amount of tokens.

​
token_in
enum<string>
required

The symbol of the token to swap from Note the supported tokens per chain.

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 Note the supported tokens per chain.

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_out
required

The amount of the token to swap to

Required range: x > 0
Example:

1.5

​
amount_in_maximum
required

The maximum amount of the token to swap from

Required range: x >= 0
Example:

1.6

​
chain
enum<string>
required

The chain to use.

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

The address of the transaction sender

​
wrap_eth
boolean
default:false

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

Example:

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

Was this page helpful?