1 of 8

DEPRECATED - V1 API Reference

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

Name

Method

Auth

Url

Get Available Networks

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

Name

Type

Description

version

String

Possible values “sandbox” | any. If a sandbox value is provided, only the Testnet networks will be returned. For any other values - only the Mainnet networks will be returned.

{
  "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
}

Get Available Routes

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

Name

Type

Description

Raw request

Raw response

Get Swap Rate

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

Name

Type

Description

Content-Type*

String

application/json

Request Body

Name

Type

Description

source*

String

destination*

String

source_asset*

String

The currency name. Example: USDC

refuel*

String

If set to true, the user will receive an additional refuel transaction in the native currency for the swap.

destination_asset

String

The currency name. Example: USDC

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

A detailed explanation of the Swap Rate Object is available here.

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
}

Create Fast Swap

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

Name

Type

Description

Headers

Name

Type

Description

Request Body

Name

Type

Description

Raw request

Raw response

Create Swap

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

Name

Type

Description

Request Body

Name

Type

Description

Raw request

Raw response

Prepare Source Transaction

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

Name

Type

Description

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

Raw Request

Raw Response

Note that you should execute this transaction manually. You should compose it based on the response and send to your wallet for execution. (Ex. User's Metamask, wallet managed by Fireblocks)

Get Swap

To check transaction status, you can retrieve created swap.

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

Get swap by Id or ReferenceId

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

Raw Request

Raw response

Get Available Networks

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

Name

Type

Description

version

String

Possible values “sandbox” | any. If a sandbox value is provided, only the Testnet networks will be returned. For any other values - only the Mainnet networks will be returned.

{
  "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
}

Get Swap Rate

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

Headers

Name

Type

Description

Content-Type*

String

application/json

Request Body

Name

Type

Description

source*

String

The supported blockchain network name.

destination*

String

The supported blockchain network/CEX/fiat provider name.

source_asset*

String

The currency name. Example: USDC

refuel*

String

If set to true, the user will receive an additional refuel transaction in the native currency for the swap.

destination_asset

String

The currency name. Example: USDC

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

A detailed explanation of the Swap Rate Object is available here.

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
}

Get Swap

To check transaction status, you can retrieve created swap.

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

Get swap by Id or ReferenceId

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

A detailed explanation of Swap Object is available .

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
}