Check out the Interactive builder to see how it looks and feels.

Parameters

from - One of the supported platforms

Source network or exchange you want the users to transfer from, for example IMMUTABLEX_MAINNET.

to - One of the supported platforms

Destination network or exchange you want the users to transfer from, for example ETHEREUM_MAINNET.

asset

The asset that you want to be preselected. NOTE: available assets depend on the selected network, for example, the asset IMX is only available in the IMMUTABLEX_MAINNET network.

destAddress

The destination address the funds should reach at the end of the swap.

lockAddress - true/false

If set to true, the destination address will be locked for editing.

hideFrom - true/false

If set to true, the source will be hidden in the UI.

lockFrom - true/false

If set to true, the source will be locked for editing.

hideTo - true/false

If set to true, the destination will be hidden in the UI.

lockTo - true/false

If set to true, the destination will be locked for editing.

lockAsset - true/false

If set to true, the asset will be locked for editing.

hideRefuel - true/false

If set to true, refuel feature will be disabled and not shown in the UI.

clientId

Clinet Id from partner setup.

If the destAddress parameter is provided, the Partner's logo will be shown next to the address.

amount

Use to pre-fill the amount field.

Users will still be able to change it in the UI. The parameter will be skipped if the asset parameter was not passed.

externalId

A unique ID representing the user's transfer session in the partner's system. This can later be used to query the status of the transfer and will be included in the webhook notifications sent to the partner. Refer to the API Reference section to learn more.

account

User account name or address that will be shown as a source.

hideFrom should be set to true

actionButtonText

Use to replace Swap now button text. For example, it can be changed to Deposit or Withdraw.

You can redirect users from your Web or Mobile app to Layerswap and customize their journey by providing query parameters.

A simple example with a predefined destination would look like this:

<!-- EXAMPLE -->
<a href="https://www.layerswap.io/app/?to=STARKNET_MAINNET&clientId=YOUR_CLIENT_ID">
    Deposit funds
</a>

Layerswap handles millions of dollars in transactions every day across multiple networks. We ensure quick and reliable crypto transfers, giving the freedom to move crypto anywhere.

You can utilize Layerswap's transacting infrastructure in four ways:

Layerswap is a prebuilt, optimized gateway that lets anyone easily and securely process transactions across multiple networks - overcoming liquidity fragmentation and complex bridging steps. Layerswap’s built-in features allow you to reduce your development time. It supports 30+ networks. You can directly into your website or direct customers to a .

You can embed the Layerswap widget directly in your app and it to fit your specific use case.

Integration demo

A simple integration workflow:

• Get , and

• using the Layerswap API

• Layerswap will monitor the source network for a transaction and will try to match it with the corresponding swap

• Once the transaction is matched and added to the swap, Layerswap will initiate a counterparty transaction to the destination_address

• (Optionally) Poll via endpoint to see if the matching transaction Input was added to the swap

• If the , Layerswap will deliver a swap status update notification to the partner-specified URL

Starter Kit

Postman Collection:

End-to-End Backend + Frontend Integration:

Swagger docs:

Examples to get started

Get Available Networks

Create Swap

For integrating Layerswap, partners should register in the and set up an organization.

Each partner account can create an organization and app(s) within that organization. The organization serves as a logical grouping for multiple associated apps. The app stores all the partner-related information like API keys for programmatic access, webhooks, and other configurations that are needed for the integration and customizations.

Register as a Partner

2. Enter your email address

3. Check your email address for a Code sent from Layerswap

4. Enter provided Code to login into the dashboard.

Setup an Organization/App

• Create an organization

• Create an app under the organization

• Go to the newly created app and copy the API key

Before creating a swap, it's possible to programmatically retrieve available sources, destinations and assets for swaps. The endpoint is public and does not require any authorization.

GET https://api.layerswap.io/api/available_networks

Query Parameters

{
  "data": [
    {
      "name": "ARBITRUM_MAINNET",
      "display_name": "Arbitrum One",
      "chain_id": "42161",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDC",
          "display_name": "USDC.e",
          "refuel": true,
          "contract": "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        }
      ]
    },
    {
      "name": "ARBITRUMNOVA_MAINNET",
      "display_name": "Arbitrum Nova",
      "chain_id": "42170",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        }
      ]
    },
    {
      "name": "STARKNET_MAINNET",
      "display_name": "StarkNet",
      "chain_id": "0x534e5f4d41494e",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDC",
          "display_name": "USDC",
          "refuel": false,
          "contract": "0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
          "decimals": 18
        }
      ]
    },
    {
      "name": "OPTIMISM_MAINNET",
      "display_name": "Optimism",
      "chain_id": "10",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDT",
          "display_name": "USDT",
          "refuel": true,
          "contract": "0x94b008aA00579c1307B0EF2c499aD98a8ce58e58",
          "decimals": 6
        },
        {
          "asset": "USDC",
          "display_name": "USDC",
          "refuel": true,
          "contract": "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        },
        {
          "asset": "OP",
          "display_name": "OP",
          "refuel": true,
          "contract": "0x4200000000000000000000000000000000000042",
          "decimals": 18
        }
      ]
    },
  ],
  "error": null
}

Raw request

curl -X 'GET' \
  'https://api.layerswap.io/api/available_networks'

Raw response

{
  "data": [
    {
      "name": "ARBITRUM_MAINNET",
      "display_name": "Arbitrum One",
      "chain_id": "42161",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDC",
          "display_name": "USDC.e",
          "refuel": true,
          "contract": "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        }
      ]
    },
    {
      "name": "ARBITRUMNOVA_MAINNET",
      "display_name": "Arbitrum Nova",
      "chain_id": "42170",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        }
      ]
    },
    {
      "name": "STARKNET_MAINNET",
      "display_name": "StarkNet",
      "chain_id": "0x534e5f4d41494e",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDC",
          "display_name": "USDC",
          "refuel": false,
          "contract": "0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
          "decimals": 18
        }
      ]
    },
    {
      "name": "OPTIMISM_MAINNET",
      "display_name": "Optimism",
      "chain_id": "10",
      "native_asset": "ETH",
      "currencies": [
        {
          "asset": "USDT",
          "display_name": "USDT",
          "refuel": true,
          "contract": "0x94b008aA00579c1307B0EF2c499aD98a8ce58e58",
          "decimals": 6
        },
        {
          "asset": "USDC",
          "display_name": "USDC",
          "refuel": true,
          "contract": "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
          "decimals": 6
        },
        {
          "asset": "ETH",
          "display_name": "ETH",
          "refuel": false,
          "contract": null,
          "decimals": 18
        },
        {
          "asset": "OP",
          "display_name": "OP",
          "refuel": true,
          "contract": "0x4200000000000000000000000000000000000042",
          "decimals": 18
        }
      ]
    },
  ],
  "error": null
}

Before creating a swap, it's possible to programmatically retrieve data about the valid minimum/maximum swap amount and the Layerswap fee. The endpoint is public and does not require any authorization.

POST https://api.layerswap.io/api/swap_rate

Headers

Request Body

{
  "data": [
    {
      "min_amount": 0.001431,
      "fee_amount": 0.0006,
      "max_amount": 0.1
    }
  ],
  "error": null
}

Raw request

curl -X 'POST' \
  'https://api.layerswap.io/api/swap_rate' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": "ETHEREUM_MAINNET",
  "destination": "ARBITRUM_MAINNET",
  "source_asset": "USDC",
  "destination_asset": "USDC",
  "refuel": true
}'

Raw Response

{
  "data": [
    {
      "min_amount": 0.001431,
      "fee_amount": 0.0006,
      "max_amount": 0.1
    }
  ],
  "error": null
}

You can programmatically generate a swap from your backend and then display the Layerswap UI to your users for transaction completion. This allows them to finalize the swap while benefiting from the Layerswap UX. To achive this:

1. using the Layerswap API.

2. Retrieve the swap_id from the response.

3. Construct a link to the transaction using the following format: https://www.layerswap.io/app/swap/{SWAP_ID_FROM_PREVIOUS_STEP}

4. Either redirect the user to the or set the URL in your .

Before creating a swap, it's possible to programmatically retrieve all possible supported routes. The endpoint is public and does not require any authorization.

GET https://api.layerswap.io/api/available_networks

Query Parameters

Raw request

Raw response

Endpoints

Swagger

Authorization

For accessing Layerswap Partner API endpoints your app(s) API KEY (retrieved from ) should be provided in X-LS-APIKEY header:

--header 'X-LS-APIKEY: {YOUR_APP_APIKEY}'

Endpoints

This endpoint return all the neccessary information to execute source transaction.

GET https://api.layerswap.io/api/swaps/{id}/prepare_src_transaction

Prepare swap deposit for execution

Path Parameters

Query Parameters

Headers

Raw Request

Raw Response

From the creation up to the completion step the swap lifecycle goes as follows:

User transfer pending (user_transfer_pending)

Whenever the swap is created, either programmatically or from the Layerswap UI, the swap has user_transfer_pending status. At this stage, Layerswap is awaiting the incoming transaction to the deposit address in the source network to match it with the corresponding swap. Users have the option to cancel the swap.

Cancelled (cancelled)

If the user decides to cancel the swap, the swap status will be changed to cancelled. The swap can still be retrieved for historical purposes, however, no incoming transaction will be matched against the swap.

Expired (expired)

If the user does not cancel the swap and also does not initiate the transaction in the source network within 4 days, the Swap status will be changed to expired.

Layerswap Transfer Pending (ls_transfer_pending)

After the user has initiated the transfer to the deposit address in the source network, Layerswap will monitor the blockchain network to verify that a transaction has been received. After receiving the transaction and matching it with the corresponding swap, Layerswap will create an Input transaction object, which will describe the transaction sent by the user and connect it with the corresponding swap. The swap status will be changed to ls_transfer_pending.

Completed (completed)

After receiving the transaction and setting the swap status to ls_transfer_pending, Layerswap will initiate the outgoing transaction to the user-specified destination address in the destination network and the swap status will be changed to completed.

Failed (failed)

If there is an issue with Layerswap and the outgoing transaction to the user-specified destination address could not be initiated, the swap status will be changed to failed.

Swap Object

Network Object

Asset Object

Transaction Object

Swap Rate Object

This endpoint provides the ability to create a swap with as few parameters as possible - destination network, asset and amount. Then, the endpoint will return all the possible source networks which can be used for transferring the funds to the destination network. The returned source networks are tracked for a possible deposit.

POST https://api.layerswap.io/api/swaps/fast

Create fast swap

Query Parameters

Headers

Request Body

Raw request

curl -X 'POST' \
  'https://localhost:9669/api/swaps/fast?clientId=f10853b323b94e10b2d9a2cddbe105a6' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "destination_address": "{YOUR_DESTINATION_ADRESS}",
  "destination_network": "ARBITRUM_GOERLI",
  "destination_asset": "ETH"
}'

Raw response

{
  "data": [
    {
      "source_address": "0x5368029018cb9f7d7d92c51d19d86835573c7679",
      "networks": [
        {
          "name": "ETHEREUM_GOERLI",
          "network_currencies": [
            {
              "asset": "ETH",
              "contract": null,
              "min_amount": 0.00073,
              "precision": 6
            }
          ]
        }
      ]
    },
    {
      "source_address": "0xfae8acb3b8243303565636aeb336c985dba9a552",
      "networks": [
        {
          "name": "IMMUTABLEX_GOERLI",
          "network_currencies": [
            {
              "asset": "ETH",
              "contract": null,
              "min_amount": 0.000121,
              "precision": 6
            }
          ]
        }
      ]
    }
  ],
  "error": null
}

To check transaction status, you can retrieve created swap.

GET https://api.layerswap.io/api/swaps/

Get swap by Id or ReferenceId

Path Parameters

Headers

{
  "data": {
    "id": "28996c7d-ee95-4727-8efe-ba0006aa16d4",
    "from_network": {
      "name": "IMMUTABLEX_GOERLI",
      "display_name": "ImmutableX Goerli",
      "logo": "https://devlslayerswapbridgesa.blob.core.windows.net/layerswap/networks/immutablex_goerli.png"
    },
    "to_network": {
      "name": "ARBITRUM_GOERLI",
      "display_name": "Arbitrum One Goerli",
      "logo": "https://devlslayerswapbridgesa.blob.core.windows.net/layerswap/networks/arbitrum_goerli.png"
    },
    "from": "Fake CEX (for testing)",
    "to": "Arbitrum One Goerli",
    "amount": 1,
    "fee": 0,
   "asset": {
      "name": "ETH",
      "display_name": "ETH",
      "logo": "https://devlslayerswapbridgesa.blob.core.windows.net/layerswap/currencies/eth.png",
      "usd_price": 1745.42,
      "contract": null,
      "decimals": 6,
      "precision": 6
    },
    "to_address": "0xC11c16C421419a11211197B7D4857ff62013a4C3",
    "source_address": "0xC11c16C421419a11211197B7D4857ff62013a4C3",
    "deposit_address": "0x7393b2a34cc9a40315fb18a33c3bf6307d346733",
    "status": "completed",
    "reference_id": "1",
    "app_name": "MyApp",
    "transactions" : [
      {
        "timestamp": 1691491520123,
        "type": "input",
        "from": "0xD5c11b416bAa7E1256E209AfaE96d734B5B0A461",
        "to": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
        "created_date": "2023-01-25T13:18:14.347986+00:00",
        "transaction_id": "0xbf521e098e100c94b9ac2203274eff799a2d54fed204bbc19816e77877481307",
        "explorer_url": "https://goerli.etherscan.io/tx/0xbf521e098e100c94b9ac2203274eff799a2d54fed204bbc19816e77877481307",
        "confirmations": 1,
        "max_confirmations": 1,
        "amount": 0.005063,
        "usd_price": 7.91539294,
        "usd_value": 0.04007563445522
      },
      {
        "timestamp": 1691491520123,
        "type": "output",
        "from": "0xCE0BaBc8398144Aa98D9210d595E3A9714910748",
        "to": "0xeBec795c9c8bBD61FFc14A6662944748F299cAcf",
        "created_date": "2023-01-25T13:18:32.031303+00:00",
        "transaction_id": "0x1e639aaf80069cbd2cbebf0c3fea974146844566e43ddd7074b9b47728e4d2d9",
        "explorer_url": "https://explorer.loopring.io/tx/0x1e639aaf80069cbd2cbebf0c3fea974146844566e43ddd7074b9b47728e4d2d9-transfer",
        "confirmations": 0,
        "max_confirmations": 0,
        "amount": 0.005,
        "usd_price": 7.8169,
        "usd_value": 0.0390845
      }
    ]
  },
  "error": null
}

Raw Request

curl -X 'GET' \
  'https://api.layerswap.io/api/swaps/{ID}' \
  --H 'X-LS-APIKEY: {YOUR_APP_APIKEY}'

Raw response

{
  "data": {
    "id": "12b21e7e-1e1e-46b4-881f-8e1bd10288c4",
    "source_network": "ETHEREUM_GOERLI",
    "destination_network": "ARBITRUM_GOERLI",
    "amount": 0.009,
    "fee": 0.000227,
    "source_asset": "ETH",
    "destination_asset": "ETH",
    "destination_address": "0x481b173fe7f9ff503d9182d0b9ad6e62336b7733",
    "status": "completed",
    "reference_id": null,
    "app": "AppForTestingAPI",
    "transactions": [
      {
        "from": "0x481b173fe7f9ff503d9182d0b9ad6e62336b7733",
        "to": "0x5da5c2a98e26fd28914b91212b1232d58eb9bbab",
        "timestamp": "2023-09-15T15:20:00+00:00",
        "transaction_hash": "0x40fa71037f71533051af0c4ff7bc9b3c5f11e58ea2fdf8bb011484e9e1262093",
        "confirmations": 3,
        "max_confirmations": 3,
        "amount": 0.01,
        "asset": "ETH",
        "type": "input"
      },
      {
        "from": "0x5da5c2a98e26fd28914b91212b1232d58eb9bbab",
        "to": "0x481b173fe7f9ff503d9182d0b9ad6e62336b7733",
        "timestamp": "2023-09-15T15:20:53+00:00",
        "transaction_hash": "0xcbc0ea13cb7748e0a9a9a45cd0c5a7bacb967e789e35d7c15b8d2877d5cf1e70",
        "confirmations": 3,
        "max_confirmations": 3,
        "amount": 0.000062,
        "asset": "ETH",
        "type": "refuel"
      },
      {
        "from": "0x5da5c2a98e26fd28914b91212b1232d58eb9bbab",
        "to": "0x481b173fe7f9ff503d9182d0b9ad6e62336b7733",
        "timestamp": "2023-09-15T15:20:53+00:00",
        "transaction_hash": "0xd3bb7b528096b149ff9f28158212930ce1a2bf1f674afff04e80c12d1fff435a",
        "confirmations": 3,
        "max_confirmations": 3,
        "amount": 0.009773,
        "asset": "ETH",
        "type": "output"
      }
    ]
  },
  "error": null
}

Mainnet Networks

Testnet networks

In these sections, you can see the complete list of supported networks, CEXes, fiat providers:

Setup

Layerswap provides a webhook configuration functionality so that Partners can receive notifications on any swap status change. Webhooks can be set up per partner application. In order to configure a webhook the following steps must be performed:

• Login to

• Select the organization/app

• From left pane select Webhooks, then provide the URL where the webhook should be received and click Create Webhook

• The newly created webhook should appear under the app

• Copy the webhook secret for future verification

Verification

In order to initiate the process of bridging assets across blockchains, CEXes, and fiat, a Swap should be created. Swap has all the necessary information required to be able to process transfers from the source to the destination.

POST https://api.layerswap.io/api/swaps

Create swap

Headers

Request Body

Raw request

Raw response