Get The Best Route

post https://api.rango.exchange/routing/best

It goes through all the possible DEX & bridges to find the best possible route based on user experience, fee amount, and output of swap.

Body Params

from

object

required

An asset unique by triple of (blockchain, symbol, address)

object

required

An asset unique by triple of (blockchain, symbol, address)

amount

string

required

The human-readable amount of asset X that is going to be swapped

connectedWallets

array of objects

The list of all connected wallets of user in all blockchains

connectedWallets

selectedWallets

object

The list of user's selected wallets to doing the swapping operation. (Blockchain to Wallet address map)

destination

string

The address of custom destination wallet, in case that you want to just swap in a blockchain because selected wallets can not support this scenario

checkPrerequisites

boolean

Defaults to false

This field should be false when the client wants to preview the route to the user and true when the user accepts the swap. If true, the server will be much slower to respond but will check some prerequisites, including the balance of X and any required fees in the user's wallets.

affiliateRef

string

The affiliate ref, which the client likes to send to Rango, so in cases of 1inch, Thorchain, etc., that support affiliation, the client will earn some money if the user accepts the route and signs the transaction.

affiliateWallets

object

List of affiliate wallets per blockchain for referral rewards

affiliatePercent

double

≤ 10

Affiliate reward for affiliator in percent (1.0 = %1.0), must be less than 1.0 percent

transactionTypes

array of strings

This field is the list of all accepted transaction types. (including EVM, TRANSFER, COSMOS, and SOLANA). An empty list means no filter is required.

transactionTypes

swappers

array of strings

The list of all accepted swappers. An empty list means no filter is required

swappers

swappersExclude

boolean

Defines the provided swappers as the include/exclude list. Default is false (include)

swapperGroups

array of strings

The list of all included/excluded swappers based on tag, empty list means no filter is required

swapperGroups

swappersGroupsExclude

boolean

Defines the provided swappers' tags as the include/exclude list. Default is false (include)

blockchains

array of strings

The list of all accepted blockchains. An empty list means no filter is required

blockchains

blockchainsExclude

boolean

Defines the provided blockchains as the include/exclude list. Default is false (include)

disableMultiStepTx

boolean

It should be true when client don't want multi step transactions. default is true

maxLength

int32

Maximum acceptable length of path

interChainMessage

object

Info about intrachain message (Source & Destination contracts and IM Message) for cross-chain messaging

messagingProtocols

array of strings

List of messaging protocols to be used for passing intrachain message

messagingProtocols

contractCall

boolean

set this parameter to true if you wants to send transactions through a contract

slippage

number

0.01 to 30

Amount of user's preferred slippage in percent

enableCentralizedSwappers

boolean

Specify that centralized swappers must be included in swappers or not. Default is false (exclude)

avoidNativeFee

boolean

When it is true, Swappers that have native tokens as fee must be excluded. example: when you call it from AA account.

Headers

X-Rango-Id

string

Responses

Response body

object

from

object

required

An asset unique by triple of (blockchain, symbol, address)

blockchain

string

required

The blockchain which this token belongs to

ETH BSC ARBITRUM POLYGON ZKSYNC STARKNET OPTIMISM AVAX_CCHAIN POLYGONZK BASE LINEA MODE TRON BTC SCROLL BLAST COSMOS OSMOSIS NEUTRON NOBLE DYDX SOLANA CRONOS BNB FANTOM AURORA MAYA THOR BOBA MOONBEAM MOONRIVER OKC BOBA_BNB BOBA_AVALANCHE LTC BCH HARMONY EVMOS HECO METIS SIF BRISE STARGAZE FUSE CRYPTO_ORG CHIHUAHUA BANDCHAIN COMDEX REGEN IRIS EMONEY GNOSIS JUNO AXELAR STRIDE KCC MARS TERRA TELOS BITSONG AKASH KI PERSISTENCE MEDIBLOC KUJIRA SENTINEL INJECTIVE SECRET KONSTELLATION STARNAME BITCANNA UMEE DESMOS LUMNETWORK TERRA_CLASSIC CELO DASH SHIMMER XLAYER IOTA POLKADOT DOGE GOERLI GOERLI_ARBITRUM GOERLI_OPTIMISM

symbol

string

required

The display symbol, e.g. USDT, BTC, etc.

address

string

Smart contract address of token, null for native tokens

object

required

An asset unique by triple of (blockchain, symbol, address)

blockchain

string

required

The blockchain which this token belongs to

symbol

string

required

The display symbol, e.g. USDT, BTC, etc.

address

string

Smart contract address of token, null for native tokens

requestAmount

number

required

The amount from request

requestId

string

required

The unique requestId generated for this request by server. It should be passed down to all other endpoints if this swap continues on

result

object

Full information of a path of multiple swaps that should be executed by user to swap X to Y

outputAmount

number

required

The estimation of Rango from output amount of Y

swaps

array of objects

required

List of required swaps to swap X to Y with the expected outputAmount

swaps*

object

swapperId

string

required

Id of the DEX or bridge that will handle this step. This id can be used to lookup in the meta service for showing icon and display name of the service

swapperLogo

string

required

Logo of swapper

swapperType

string

required

Type of the swapper

BRIDGE DEX AGGREGATOR OFF_CHAIN

from

object

required

Source or destination asset of a step

object

required

Source or destination asset of a step

fromAmount

number

required

Estimated input amount of this step. Can be used for previewing to user and should not be used for real computation, since it may change when the real transaction happens due to volatility of the market

fromAmountPrecision

number

The minimum amount unit, the precision that will be applied to transaction amount in create transaction endpoint automatically by Rango. This field is informational and there is no need to apply it in client-side

fromAmountMinValue

number

Minimum required amount of the source asset of this step. It's a limitation from DEX orbridge that is executing this step. ex: Binance Bridge needs min of 234 MATIC for swapping MATIC from BSC to POLYGON. Beware that if fromAmount < fromAmountMinValue you should not let user start the swap. Null value indicates that there is no limitation.

fromAmountMaxValue

number

Exactly the same as fromAmountMinValue, but for the maximum limit

fromAmountRestrictionType

string

Specifies range for fromAmount(Min/Max)Value. for example if value is EXCLUSIVE and fromAmountMinValue is 20, user can execute transaction if inputValue>20, but for INCLUSIVE inputValue>=20 is valid

INCLUSIVE EXCLUSIVE

toAmount

number

required

Estimated output amount of this step

fee

array of objects

required

List of fees that are taken from user in this step

fee*

object

asset

object

required

An asset unique by triple of (blockchain, symbol, address)

expenseType

string

required

The type of fee

FROM_SOURCE_WALLET DECREASE_FROM_OUTPUT FROM_DESTINATION_WALLET

amount

number

required

The human readable amount of fee

name

string

required

A display name for this fee

200OK

404Not Found