Get quote for pair

Returns the best exchange offer and input parameters for the transaction.

Request

Authorization

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

chainID

enum<integer>

required

The blockchain ID.

(Supported list: v1/platforms)

Allowed values:

110561372504216143114

Default:

Example:

Query Params

fromTokenAddress

string

required

Smart contract address of the sale token.

Default:

0xdac17f958d2ee523a2206206994597c13d831ec7

Example:

0xdac17f958d2ee523a2206206994597c13d831ec7

toTokenAddress

string

required

Smart contract address of the purchase token.

Default:

0x6b175474e89094c44da98b954eedeac495271d0f

Example:

0x6b175474e89094c44da98b954eedeac495271d0f

takerAddress

string

optional

The address which will fill the quote. When provided the gas will be estimated and returned.

amount

integer

required

The amount of sale tokens in decimals of the token (Decimals can be taken from the method /tokens/list).

Default:

1500000000

Example:

1500000000

slippage

integer

required

The amount of slippage allowed during the actual execution of the transaction (10 = 1% slippage). If the price changes by more than this percentage, the transaction will revert. Min = 1 (0.1%), max = 500 (50%). Default value: 1.

Default:

Example:

gasPrice

string

optional

Gas price value for making a transaction in WEI (nAVAX for Avalanche) (1 GWEI = 1000000000 WEI), default value is the value high from /{chainID}/gasprices.

Default:

16000000000

feeRecipient

string

optional

Wallet address for receiving fees.

The commission is paid from the purchase or sale token. It depends on which of the fields is sent in the request: buyTokenPercentageFee or sellTokenPercentageFee.

Default:

0xdac17f958d2ee523a2206206994597c13d831ec7

buyTokenPercentageFee

number

optional

Percentage of commission from the amount of purchase tokens, is taken in favor of 'feeRecipient'. (10 = 1%, maximum value is 500).

sellTokenPercentageFee

number

optional

Percentage of commission from the amount of sale tokens, is taken in favor of 'feeRecipient'. (10 = 1%, maximum value is 500).

recipientAddress

string

optional

Wallet address for receiving purchase tokens.\n\n If this field is not specified, then the recipient of the tokens will be the one who sends the transaction for the exchange.

skipValidation

boolean

optional

Validation flag. If value is true - validation will be skipped.

Default:

true

excludeAggregator

string

optional

Exclude some aggregators from routing (add several parameters for multiple exclude).

includeAggregator

string

optional

Include some aggregators from routing (add several parameters for multiple include). This parameter cannot be combined with excludedAggregators.

withGas

boolean

optional

If TRUE: choose a quote based on gas.

Default:

false

rfqOnly

boolean

optional

If TRUE: use only RFQ providers for routing.

Note: If set to TRUE, the excludeAggregator and includeAggregator fields are ignored.

Default:

false

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

amount_out_total

string

optional

The amount of purchase tokens in decimals of the token.

Example:

1497761574710071333259

estimate_gas_total

string

optional

The estimated amount of gas that will be used during the transaction.

Example:

127000

token_in

string

optional

Smart contract address of the sale token.

Example:

0xdac17f958d2ee523a2206206994597c13d831ec7

token_out

string

optional

Smart contract address of the purchase token.

Example:

0x6b175474e89094c44da98b954eedeac495271d0f

gas_price

string

optional

Gas price value for a transaction in WEI (nAVAX for Avalanche).

Example:

127000

fee_recipient_amount

string

optional

The amount of purchase tokens in decimals of the token which will be taken in favor of feeRecipient.

The value will be 0 if feeRecipient and buyTokenPercentageFee parameters are not specified

routes

array[object (types.Protocols) {6}]

optional

An array of DEXs the transaction will be carried out through.

type

string

optional

Liquidity source type.

Example:

dex

protocol_name

string

optional

DEX name the transaction will be carried out through.

Example:

Uniswap_V3

amount_in

string

optional

Amount of token to exchange.

Example:

1500000000

amount_out

string

optional

Expected amount of token out.

Example:

1497761574710071333259

percent

number

optional

The percent of amount that will be swapped on the current DEX.

Example:

100

pools

object

optional

The array of liquidity pools through which the exchange will be conducted.

calldata

string

optional

One of the input parameters for processing a transaction for tokens exchange.

Example:

0x318ced5d000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000005061c2da8cfb40f01700000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000059682f000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000018000000000000000000000006f48eca74b38d2936b02ab603ff4e36a6c0e3a77

expiry

integer

optional

Quote expiration time (in unix epoch time format). Applicable for RFQ providers only.

string

optional

Smart contract address where input parameters should be sent to.

Example:

0x0000000000000000000000000000000000

Example

{
    "amount_out_total": "1497761574710071333259",
    "estimate_gas_total": "127000",
    "token_in": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "token_out": "0x6b175474e89094c44da98b954eedeac495271d0f",
    "gas_price": "127000",
    "fee_recipient_amount": "string",
    "routes": [
        {
            "type": "dex",
            "protocol_name": "Uniswap_V3",
            "amount_in": "1500000000",
            "amount_out": "1497761574710071333259",
            "percent": 100,
            "pools": {
                "protocol_name": "string",
                "pool_address": "string",
                "amount_in": "string",
                "amount_out": "string",
                "zero_for_one": true,
                "token0": "string",
                "token1": "string"
            }
        }
    ],
    "calldata": "0x318ced5d000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000005061c2da8cfb40f01700000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000059682f000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000018000000000000000000000006f48eca74b38d2936b02ab603ff4e36a6c0e3a77",
    "expiry": 0,
    "to": "0x0000000000000000000000000000000000"
}

🟢204No Content