Skip to main content
POST
Get a set of routes for a request that describes a transfer of tokens
Need opinionated routing defaults? Include options.preset in the request body and review the API presets overview for the supported configurations.

Headers

x-lifi-api-key
string

Authentication header, register in the LI.FI Partner Portal (https://portal.li.fi/ ) to get your API Key.

Body

application/json

The request object describes a desired any-to-any transfer and contains all information necessary to calculate the most efficient routes.

A description of a token transfer

fromChainId
number<number>
required

The sending chain id

fromAmount
string
required

The amount that should be transferred including all decimals (e.g. 1000000 for 1 USDC (6 decimals))

fromTokenAddress
string
required

The address of the sending Token

toChainId
number<number>
required

The id of the receiving chain

toTokenAddress
string
required

The address of the receiving Token

options
Root Type for RouteOptions ยท object

Optional configuration for the routes

Example:
fromAddress
string

The sending wallet address

toAddress
string

The receiving wallet address

fromAmountForGas
string

The amount of the token to convert to gas on the destination side.

Response

The resulting routes that can be used to realize the described transfer of tokens

A list of routes that can be used to realize the described transfer of tokens

routes
Root Type for Route ยท object[]
required

List of possible Routes for the given transfer

unavailableRoutes
object[]

An object representing the routes that are unavailable for the given transfer