GET /indicative-quote

Get amount out for selling a ERC20 / native token.

GET https://newapi.native.org/v1/indicative-quote

This endpoint provides amount of token out given the requested token and token amount. Native routing optimises for the best pricing among on-chain aggregators and private market makers.

Native supports native token swap by using 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE to represent the token address of the native token.

Headers

NameDescription

apiKey

API Key retrieved from the Native app.

Params

NameDescription

src_chain*

The blockchain name belonging to the token_in address. You can refer to supported chain API.

dst_chain*

The blockchain name belonging to the token_out address. You can refer to supported chain API.

token_in*

Address of the token to be sold.

token_out*

Address of the token to be bought.

amount

Amount of token to be sold, in ether unit.

amount_wei

Amount of token to be sold, in wei unit.

from_address*

Address of the user that sells the token_in.

to_address

Address of the user that receives the token_out. If empty, this address will be the same as from_address.

expiry_time

The expiry time of the quote, in seconds.

Example

https://newapi.native.org/v1/indicative-quote?chain=ethereum&token_in=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&token_out=0xdAC17F958D2ee523a2206206994597C13D831ec7&amount=1&from_address=0x42d4e9ee3f725c84b7934e4fda64f2be0f803130

In this example, wallet 0x42d4e9ee3f725c84b7934e4fda64f2be0f803130 requests quote for swapping 1 ETH to USDT on Ethereum.

Response

NameDescription

success

Indicates if the quote was successful fetched.

buyerToken

The ERC20 token address of the buyer's token. This is the token the market maker will receive.

sellerToken

The ERC20 token address of the seller's token. This is the token that will be sent to market maker.

buyerTokenAmount

The token out amount of the order in ether.

buyerTokenAmountWei

The token out amount of the order in wei.

sellerTokenAmount

The token input amount of the order in ether.

sellerTokenAmountWei

The token input amount of the order in wei.

price

Price = buyerTokenAmount / sellerTokenAmount.

widgetFeeUsd

The platform fee charged by the widget owner.

liquidityProviderFeeUsd

The fee that will be paid to the liquidity provider.

totalFeeUsd

The total fees to be paid, if this order was executed.

routes

The routes taken for the provided quote. Native router will find the shortest route if there is no direct liquidity for the given pair.

Example response:

{
    "success": true,
    "buyerToken": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
    "sellerToken": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
    "buyerTokenAmount": 1846.565451,
    "buyerTokenAmountWei": "1846565451",
    "sellerTokenAmount": "1",
    "sellerTokenAmountWei": "1000000000000000000",
    "price": 1846.565451,
    "widgetFeeUsd": 0,
    "liquidityProviderFeeUsd": 0,
    "totalFeeUsd": 0,
    "routes": [
        "ETH",
        "USDT"
    ],
}

In the response above, Native returns 1846,565451 USDT for the order sent in the example.

You may try this endpoint out here.

Last updated