Get Swap Details

Retrieves the details of a specific swap by its ID.

GET /api/v2/swaps/{swapId}

Get Swap Details

cURL

curl --request GET \
  --url https://api.layerswap.io/api/v2/swaps/{swapId} \
  --header 'X-LS-APIKEY: <api-key>'

import requests

url = "https://api.layerswap.io/api/v2/swaps/{swapId}"

headers = {"X-LS-APIKEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-LS-APIKEY': '<api-key>'}};

fetch('https://api.layerswap.io/api/v2/swaps/{swapId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.layerswap.io/api/v2/swaps/{swapId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-LS-APIKEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.layerswap.io/api/v2/swaps/{swapId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-LS-APIKEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.layerswap.io/api/v2/swaps/{swapId}")
  .header("X-LS-APIKEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.layerswap.io/api/v2/swaps/{swapId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-LS-APIKEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "metadata": {}
  },
  "data": {
    "quote": {
      "total_fee": 123,
      "total_fee_in_usd": 123,
      "source_network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "source_token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "destination_network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "destination_token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "requested_amount": 123,
      "receive_amount": 123,
      "fee_discount": 123,
      "min_receive_amount": 123,
      "blockchain_fee": 123,
      "service_fee": 123,
      "avg_completion_time": "<string>",
      "refuel_in_source": 123,
      "slippage": 123,
      "rate": 123,
      "path": [
        {
          "provider": "<string>",
          "order": 123
        }
      ]
    },
    "refuel": {
      "token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "amount": 123,
      "amount_in_usd": 123
    },
    "reward": {
      "token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "amount": 123,
      "amount_in_usd": 123,
      "campaign_type": "<string>",
      "nft_contract_address": "<string>"
    },
    "swap": {
      "id": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "source_network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "source_token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "source_exchange": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "metadata": {
          "oauth": {
            "authorize_url": "<string>",
            "connect_url": "<string>"
          },
          "listing_date": "2023-11-07T05:31:56Z"
        }
      },
      "destination_network": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "chain_id": "<string>",
        "node_url": "<string>",
        "nodes": [
          "<string>"
        ],
        "transaction_explorer_template": "<string>",
        "account_explorer_template": "<string>",
        "source_rank": 123,
        "destination_rank": 123,
        "token": {
          "symbol": "<string>",
          "display_asset": "<string>",
          "logo": "<string>",
          "contract": "<string>",
          "decimals": 123,
          "price_in_usd": 123,
          "precision": 123,
          "listing_date": "2023-11-07T05:31:56Z",
          "source_rank": 123,
          "destination_rank": 123,
          "group": "<string>"
        },
        "metadata": {
          "listing_date": "2023-11-07T05:31:56Z",
          "evm_oracle_contract": "<string>",
          "evm_multicall_contract": "<string>",
          "zks_paymaster_contract": "<string>",
          "watchdog_contract": "<string>"
        },
        "deposit_methods": [
          "<string>"
        ]
      },
      "destination_token": {
        "symbol": "<string>",
        "display_asset": "<string>",
        "logo": "<string>",
        "contract": "<string>",
        "decimals": 123,
        "price_in_usd": 123,
        "precision": 123,
        "listing_date": "2023-11-07T05:31:56Z",
        "source_rank": 123,
        "destination_rank": 123,
        "group": "<string>"
      },
      "destination_exchange": {
        "name": "<string>",
        "display_name": "<string>",
        "logo": "<string>",
        "metadata": {
          "oauth": {
            "authorize_url": "<string>",
            "connect_url": "<string>"
          },
          "listing_date": "2023-11-07T05:31:56Z"
        }
      },
      "requested_amount": 123,
      "destination_address": "<string>",
      "status": "<string>",
      "fail_reason": "<string>",
      "use_deposit_address": true,
      "metadata": {
        "sequence_number": 123,
        "reference_id": "<string>",
        "exchange_account": "<string>"
      },
      "transactions": [
        {
          "from": "<string>",
          "to": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "transaction_hash": "<string>",
          "confirmations": 123,
          "max_confirmations": 123,
          "amount": 123,
          "type": "<string>",
          "status": "<string>",
          "token": {
            "symbol": "<string>",
            "display_asset": "<string>",
            "logo": "<string>",
            "contract": "<string>",
            "decimals": 123,
            "price_in_usd": 123,
            "precision": 123,
            "listing_date": "2023-11-07T05:31:56Z",
            "source_rank": 123,
            "destination_rank": 123,
            "group": "<string>"
          },
          "network": {
            "name": "<string>",
            "display_name": "<string>",
            "logo": "<string>",
            "chain_id": "<string>",
            "node_url": "<string>",
            "nodes": [
              "<string>"
            ],
            "transaction_explorer_template": "<string>",
            "account_explorer_template": "<string>",
            "source_rank": 123,
            "destination_rank": 123,
            "token": {
              "symbol": "<string>",
              "display_asset": "<string>",
              "logo": "<string>",
              "contract": "<string>",
              "decimals": 123,
              "price_in_usd": 123,
              "precision": 123,
              "listing_date": "2023-11-07T05:31:56Z",
              "source_rank": 123,
              "destination_rank": 123,
              "group": "<string>"
            },
            "metadata": {
              "listing_date": "2023-11-07T05:31:56Z",
              "evm_oracle_contract": "<string>",
              "evm_multicall_contract": "<string>",
              "zks_paymaster_contract": "<string>",
              "watchdog_contract": "<string>"
            },
            "deposit_methods": [
              "<string>"
            ]
          },
          "fee_amount": 123,
          "fee_token": {
            "symbol": "<string>",
            "display_asset": "<string>",
            "logo": "<string>",
            "contract": "<string>",
            "decimals": 123,
            "price_in_usd": 123,
            "precision": 123,
            "listing_date": "2023-11-07T05:31:56Z",
            "source_rank": 123,
            "destination_rank": 123,
            "group": "<string>"
          }
        }
      ]
    }
  }
}

Authorizations

X-LS-APIKEY · string · header · required

Headers

X-LS-APIKEY · string · default: NDBxG+aon6WlbgIA2LfwmcbLU52qUL9qTnztTuTRPNSohf/VnxXpRaJlA5uLSQVqP8YGIiy/0mz+mMeZhLY4/Q

Path Parameters

swapId · string<uuid> · required

Query Parameters

exclude_deposit_actions · boolean

source_address · string

Response

200 - application/json

Success

error · object

Show child attributes

data · object

Show child attributes