Widget Component

Core Configuration

Swap Details

Routing & Filtering Options

UI Appearance & Behavior

Integration Hooks & State

API documentation for the widget components and hooks.

Widget API Reference

Get the best price execution for any swaps and bridging across EVM chains, Solana, Bitcoin and alt-VMs. Enable trading across all DEX aggregators, bridges, and intent-systems and save hundreds of developer hours.

LI.FI

LI.FI Home Page

What is LI.FI?

Why LI.FI?

Understanding LI.FI Performance and Functionality

LI.FI vs Aggregators/DEXs/Bridges?

Powered by LI.FI

Getting started

As an integrator, you can monetize LI.FI and collect fees from our Widget/SDK/API integration.

Monetizing the integration

Partnership opportunities

System Overview

Smart Contract Overview

Smart Contract Addresses

LI.Fuel Overview

Bitcoin Overview

Solana Overview

End-to-end Transaction Example

Fetching a Quote/Route

Quote vs Route

LI.FI Zaps (Contract Calls) Documentation

Tx Batching aka "Zaps"

Monetization

Solana transaction example

Bitcoin transactoin example

Security and Audits

Overview

Rate Limits and API Authentication

Error Codes

Cross-chain and on-chain swap and bridging toolkit

LI.FI SDK overview

Integrate our LI.FI SDK to your dApp/Wallet/Swap UI

Install LI.FI SDK

Get started and set up LI.FI SDK in just a few lines of code.

Configure SDK

Seamlessly connecting every ecosystem for your needs

Configure SDK Providers

Prior to executing any swap or bridging, you need to request the best route from our smart routing API..

Request Routes/Quotes

We allow you to execute any on-chain or cross-chain swap and bridging transfer and a combination of both..

Execute Routes/Quotes

Request all available chains, bridges, and exchanges.

Chains and Tools

Request all available tokens and their balances, manage token approvals and more.

Token Management

Testing Integration

Migration guide for upgrading LI.FI SDK v2 to v3

Migrate from v2 to v3

Test and play around with customization options

LI.FI Widget Playground

Cross-chain and on-chain swap and bridging UI toolkit

LI.FI Widget Overview

Install Widget

Customize your experience with our versatile variants

Select Widget Variants

Configure Widget

Customize the look and feel of the widget to match the design of your dApp and suit your needs

Customize Widget

Widget Events

Configure your widget for seamless wallet management

Wallet Management

Unlock global communities with effortless internationalization support

Internationalization

Integrate the widget with your Next.js, Remix or Nuxt application

Compatibility with Next.js, Remix, Nuxt, etc.

React Router Compatibility

Migration guide for upgrading LI.FI Widget v2 to v3

Additions and updates to the core LI.FI service

Core

Additions and updates to the LI.FI widget

Widget

Are you a bridge, DEX, aggregator, or solver looking to get added into LI.FI routing?

Getting Integrated by LI.FI

DEX/Aggregator/Solver integration requirements

For DEXs/Aggregators/Solvers

For Bridges

Get access to all DEXs, DEX aggregators on ~18 chains, and all the relevant bridges. LI.FI allows you to swap, bridge, and a combination of both within one transaction.

Navigating the LI.FI API

Learn about our rate limits and how to obtain and configure an API key.

If you want to learn more about how to use this endpoint please have a look at our [guide](https://docs.li.fi/more-integration-options/li.fi-api/requesting-supported-chains).

Get information about all currently supported chains

This endpoint can be used to fetch all tokens known to the LI.FI services. Both chainID and chain symbol can be provided.

Fetch all known tokens

This endpoint can be used to get more information about a token by its address or symbol and its chain.
If you want to learn more about how to use this endpoint please have a look at our [guide](https://docs.li.fi/more-integration-options/li.fi-api/getting-token-information).

Fetch information about a Token

This endpoint can be used to get information about the bridges and exchanges available trough our service.
At least one chain needs to be provided.
If one chain is provided, the response will return a list of bridges and supported connections via that bridge which includes the provided chain, and all dexes on that chain.
If two chains are provided, the response  will return a list of bridges that support transfers between the two chains and a list of dexes that support either one of the chains.

Get available bridges and exchanges

This endpoint gives information about all possible tranfers between chains.
Since the result can be very large it is required to filter by at least a chain, a token, a bridge, or an exchange.
Information about which chains and tokens are supported can be taken from the response of the /v1/chains endpoint.
Information about which bridges and exchanges are supported can be taken from the response of the /tools endpoint.
For chains both chainID or chain symbol can be provided. For tokens both token address or token symbol can be provided. 
It is always recommended to use chainID and token address for accuracy.

Returns all possible connections based on a from- or toChain.

This endpoint can be used to get the most recent gas prices for the supplied chainId.

Get gas price for the specified chainId

This endpoint can be used to get the most recent gas prices for the enabled chains in the server.

Get gas prices for enabled chains

Cross chain transfers might take a while to complete. Waiting on the transaction on the sending chain doesn't help here. For this reason we build a simple endpoint that let's you check the status of your transfer.
Important: The endpoint returns a `200` successful response even if the transaction can not be found. This behavior accounts for the case that the transaction hash is valid but the transaction has not been mined yet.
While non of the parameters `fromChain`, `toChain` and `bridge` are required, passing the `fromChain` parameter will speed up the request and is therefore encouraged.
If you want to learn more about how to use this endpoint please have a look at our [guide](https://docs.li.fi/more-integration-options/li.fi-api/checking-the-status-of-a-transaction).

Check the status of a cross chain transfer

This endpoint can be used to get transaction request for withdrawing integrator's collected fees the specified chain. If a list of token addresses is provided, the generated transaction will only withdraw the specified funds.
If there is no collected fees for the provided token's addresses, the `400` error will be thrown.
The endpoint returns a `IntegratorWithdrawalTransactionResponse` object which contains the transaction request.

Get transaction request for withdrawing collected integrator's fees by chain

This endpoint can be used to request all integrator's collected fees data by tokens for all supported chains.
The endpoint returns an `Integrator` object which contains the integrator id and an array of fee balances for all supported chains.

Get integrator's collected fees data for all supported chains

Calculates and returns the total received token amount per wallet address, per sending chain, within a specified time range, for a given receiving chain and receiving token. Only aggregates cross-chain transfers, meaning transfers with distinct sending and receiving chains.

Get the total amount of a token received on a specific chain, for cross-chain transfers.

This endpoint can be used to retrieve a list of transfers filtered by certain properties. Returns a maximum of 1000 transfers.

Get a list of filtered transfers

A paginated version of the `GET /v1/analytics/transfers endpoint`. This endpoint can be used to retrieve a list of transfers filtered by certain properties.

Get a paginated list of filtered transfers

This endpoint can be used to request a quote for a transfer of one token to another, cross chain or not.
The endpoint returns a `Step` object which contains information about the estimated result as well as a `transactionRequest` which can directly be sent to your wallet.
The estimated result can be found inside the `estimate`, containing the estimated `toAmount` of the requested `Token` and the `toAmountMin`, which is the guaranteed minimum value that the transfer will yield including slippage.
If you want to learn more about how to use this endpoint please have a look at our [guide](https://docs.li.fi/more-integration-options/li.fi-api/requesting-a-quote).
To learn more about our terminology please check our [article](https://docs.li.fi/overview/li.fi-terminology).
To learn about the differences between /quote and /advanced/routes endpoints please review our [guide](https://help.li.fi/hc/en-us/articles/23191616039835-Difference-between-the-quote-and-advanced-routes-endpoints).
NOTE: Solana ATA fees are returned as `feeCosts`  

Get a quote for a token transfer

This endpoint has been deprecated in favour of /quote/contractCalls.

Perform a contract call across blockchains (BETA)

This endpoint returns all possible routes including single and multistep txs.
In order to execute any transfer, you must first request possible `Routes`. From the result set a `Route` can be selected and executed by retrieving the transaction for every included `Step` using the `/advanced/stepTransaction` endpoint.
**Attention**: This request is more complex and intended to be used via our [JavaScript SDK](https://docs.li.fi/integrate-li.fi-js-sdk/install-li.fi-sdk).
More information about the differences between /quote and /advanced/routes endpoints can be found [here](https://help.li.fi/hc/en-us/articles/23191616039835-Difference-between-the-quote-and-advanced-routes-endpoints).
NOTE: Solana ATA fees are returned as `feeCosts`

Get a set of routes for a request that describes a transfer of tokens

This endpoint expects a full `Step` object which usually is retrieved by calling the `/routes` endpoint and selecting the most suitable `Route`. Afterwards the transaction for every required `Step` can be retrieved using this endpoint.
**Attention**: This request is more complex and intended to be used via our [JavaScript SDK](https://docs.li.fi/integrate-li.fi-js-sdk/install-li.fi-sdk).

Populate a step with transaction data

This endpoint allows to pass transaction call data. It will then parse the call data based on known and on-chain ABIs to provide a JSON overview of the internal transaction information.

Parse transaction call data (BETA)

Additions and updates to the LI.FI backend

Name	Type	Default	Example	Description
`apiKey`	`string`	–	`integrator`	API authentication key
`integrator`	`string`	–	`OpenSea`	Identifier of the integrator (dApp/company)
`referrer`	`string`	–	–	Identifier of the referrer
`fee`	`number`	`0.05`	–	Float between 0 and 1 (e.g. 0.1 = 10% fee)

Name	Type	Default	Example	Description
`fromChain`	`number`	–	`42161`	Source chain ID
`fromToken`	`string`	–	`0x539b...0342`	Token contract address (source)
`fromAmount`	`number`	`0`	`69.42`	Token amount to swap
`toChain`	`number`	`1`	`137`	Destination chain ID
`toToken`	`string`	–	`0xd6df...1c90b`	Destination token contract address
`toAddress`	`ToAddress`	–	`0x2b56...1401`	Destination wallet address
`slippage`	`number`	`0.005`	–	Default slippage setting
`useRecommendedRoute`	`boolean`	`false`	`true`	Show only recommended route

Name	Type	Default	Example	Description
`routePriority`	`'CHEAPEST' \| 'FASTEST'`	`'CHEAPEST'`	–	Route selection priority
`chains`	`{ allow?: number[]; deny?: number[] }`	–	–	Allowed or denied chains
`tokens`	`{ featured?, include?, popular?, allow?, deny? }`	–	–	Token filtering and prioritization
`bridges`	`{ allow?: string[]; deny?: string[] }`	–	–	Bridge control list
`exchanges`	`{ allow?: string[]; deny?: string[] }`	–	–	Exchange control list

Name	Type	Default	Example	Description
`variant`	`'compact' \| 'wide' \| 'drawer'`	`'compact'`	–	Widget layout style
`subvariant`	`'default' \| 'split' \| 'refuel' \| 'custom'`	`'default'`	–	Additional layout customization
`appearance`	`'light' \| 'dark' \| 'auto'`	`'auto'`	`'dark'`	Theme mode
`disabledUI`	`DisabledUIType[]`	–	`['fromAmount', 'toAddress']`	UI parts to disable
`hiddenUI`	`HiddenUIType[]`	–	`['appearance', 'language']`	UI parts to hide
`requiredUI`	`RequiredUIType[]`	–	`['toAddress']`	Required UI fields
`theme`	`ThemeConfig`	–	–	Theme palette and typography
`languages`	`{ default?, allow?, deny? }`	–	–	Language preferences
`languageResources`	`LanguageResources`	–	–	Custom i18n translations

Name	Type	Default	Example	Description
`walletConfig`	`WidgetWalletConfig`	–	–	Options to manage wallet state
`sdkConfig`	`WidgetSDKConfig`	–	–	SDK-specific configuration
`formRef`	`MutableRefObject<FormState \| null>`	–	–	Access for programmatic form updates
`buildUrl`	`boolean`	`false`	–	Append widget config to page URL
`explorerUrls`	`Record<number, string[]> & Partial<Record<'internal', string[]>>`	–	–	Custom block explorer links

LI.FI Widget

​Widget Component

​Core Configuration

​Swap Details

​Routing & Filtering Options

​UI Appearance & Behavior