githubEdit

Quote

get

Retrieves a quote for a token swap between different chains.

Query parameters
fromChainstringRequired
  • The source blockchain identifier.
toChainstringRequired
  • The destination blockchain identifier.
fromTokenstringRequired
  • The token address on the source chain.
toTokenstringRequired
  • The token address on the destination chain.
fromAmountstringRequired
  • The amount of the source token to swap.
fromAddressstringRequired
  • The address of the sender on the source chain.
toAddressstringOptional
  • The address of the recipient on the destination chain (optional).
orderstring · enumOptional
  • The order preference for the quote ('BEST_VALUE', 'BEST_FEE', 'BEST_FEE_GAS') (optional).
Possible values:
slippagenumber · doubleOptional
  • The maximum acceptable slippage percentage (optional).
integratorstringOptional
  • The integrator identifier (optional).
feenumber · doubleOptional
  • The fee amount (optional).
referrerstringOptional
  • The referrer identifier (optional).
allowBridgesstring[]Optional
  • A list of allowed bridges (optional).
allowExchangesstring[]Optional
  • A list of allowed exchanges (optional).
denyBridgesstring[]Optional
  • A list of denied bridges (optional).
denyExchangesstring[]Optional
  • A list of denied exchanges (optional).
preferBridgesstring[]Optional
  • A list of preferred bridges (optional).
preferExchangesstring[]Optional
  • A list of preferred exchanges (optional).
Responses
chevron-right
200

A promise that resolves to an ApiResponse containing the quote data.

application/json
get
/lifi/quote
200

A promise that resolves to an ApiResponse containing the quote data.

post

Handles the retrieval of a quote for a token swap between different chains.

Path parameters
accountNamestringRequired
  • The name of the account requesting the quote.
Query parameters
fromChainstringRequired
  • The chain from which the token swap will originate.
toChainstringRequired
  • The chain to which the token swap will be sent.
fromTokenstringRequired
  • The token to be swapped from.
toTokenstringRequired
  • The token to be swapped to.
fromAmountstringRequired
  • The amount of the token to be swapped from.
fromAddressstringRequired
  • The address from which the token swap will originate.
toAddressstringOptional
  • (Optional) The address to which the token swap will be sent.
orderstring · enumOptional
  • (Optional) The order preference for the quote (BEST_VALUE, BEST_FEE, BEST_FEE_GAS).
Possible values:
slippagenumber · doubleOptional
  • (Optional) The acceptable slippage percentage for the swap.
integratorstringOptional
  • (Optional) The integrator identifier.
feenumber · doubleOptional
  • (Optional) The fee for the swap.
referrerstringOptional
  • (Optional) The referrer identifier.
allowBridgesstring[]Optional
  • (Optional) The list of allowed bridges for the swap.
allowExchangesstring[]Optional
  • (Optional) The list of allowed exchanges for the swap.
denyBridgesstring[]Optional
  • (Optional) The list of denied bridges for the swap.
denyExchangesstring[]Optional
  • (Optional) The list of denied exchanges for the swap.
preferBridgesstring[]Optional
  • (Optional) The list of preferred bridges for the swap.
preferExchangesstring[]Optional
  • (Optional) The list of preferred exchanges for the swap.
dryRunbooleanOptional
broadcastbooleanOptional
Header parameters
AuthorizationstringRequired
  • The authorization token for the request.
Responses
chevron-right
200

A promise that resolves to an ApiResponse containing the quote details, signed transaction, and broadcast information.

application/json
post
/lifi/{accountName}/quote
200

A promise that resolves to an ApiResponse containing the quote details, signed transaction, and broadcast information.