Skip to main content
GET
/
getStatus
Get Status
curl --request GET \
  --url https://api-v2.swaps.xyz/api/getStatus \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api-v2.swaps.xyz/api/getStatus"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-v2.swaps.xyz/api/getStatus', 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-v2.swaps.xyz/api/getStatus",
  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-api-key: <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-v2.swaps.xyz/api/getStatus"

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

	req.Header.Add("x-api-key", "<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-v2.swaps.xyz/api/getStatus")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-v2.swaps.xyz/api/getStatus")

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

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

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "sender": "0x1234567890123456789012345678901234567890",
  "srcChainId": 1,
  "bridgeDetails": {
    "isBridge": true,
    "bridgeTime": 420,
    "txPath": [
      {
        "chainId": 1,
        "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
        "timestamp": 1640995200,
        "nextBridge": "layerZero"
      }
    ]
  },
  "txId": "0x49b1d3d38176e45864fd55500c6c1879ab318609e1ed0c8eb9abd818e6c811fd",
  "dstChainId": 42161,
  "srcTxHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "dstTxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "actionRequest": {
    "sender": "<string>",
    "srcChainId": 123,
    "srcToken": "<string>",
    "dstChainId": 123,
    "dstToken": "<string>",
    "slippage": 5000,
    "amount": "<string>",
    "recipient": "<string>",
    "to": "<string>",
    "data": "<string>",
    "value": "<string>",
    "erc20Amount": "<string>",
    "erc20Spender": "<string>",
    "bridgeIds": [
      "<string>"
    ],
    "refundTo": "<string>",
    "appFees": [
      {
        "bps": 123,
        "receiverAddress": "<string>"
      }
    ]
  },
  "actionResponse": {
    "tx": {
      "to": "<string>",
      "data": "<string>",
      "value": "<string>",
      "chainId": 123
    },
    "txId": "<string>",
    "amountIn": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "amountInMax": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "amountOut": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "amountOutMin": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "protocolFee": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "applicationFee": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "exchangeRate": 123,
    "estimatedTxTime": 123,
    "estimatedPriceImpact": 123,
    "requiresTokenApproval": true,
    "requiresRegisterTransaction": true,
    "allRoutes": [
      {
        "tx": {
          "to": "<string>",
          "data": "<string>",
          "value": "<string>",
          "chainId": 123
        },
        "txId": "<string>",
        "amountIn": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "amountInMax": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "amountOut": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "amountOutMin": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "protocolFee": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "applicationFee": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "exchangeRate": 123,
        "estimatedTxTime": 123,
        "estimatedPriceImpact": 123,
        "requiresRegisterTransaction": true,
        "bridgeFee": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        },
        "bridgeIds": [
          "<string>"
        ],
        "bridgeRoute": [
          {
            "srcChainId": 123,
            "dstChainId": 123,
            "srcBridgeToken": "<string>",
            "dstBridgeToken": "<string>",
            "bridgeId": "<string>"
          }
        ],
        "executions": [
          {
            "txType": "evmTransactionSign",
            "data": "<string>",
            "signature": "<string>"
          }
        ],
        "relayerFee": {
          "chainId": 123,
          "address": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "isNative": true,
          "amount": "<string>",
          "logo": "<string>",
          "swapsXyzCode": "<string>",
          "usdAmount": 123
        }
      }
    ],
    "bridgeFee": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    },
    "bridgeIds": [
      "<string>"
    ],
    "bridgeRoute": [
      {
        "srcChainId": 123,
        "dstChainId": 123,
        "srcBridgeToken": "<string>",
        "dstBridgeToken": "<string>",
        "bridgeId": "<string>"
      }
    ],
    "executions": [
      {
        "txType": "evmTransactionSign",
        "data": "<string>",
        "signature": "<string>"
      }
    ],
    "relayerFee": {
      "chainId": 123,
      "address": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "isNative": true,
      "amount": "<string>",
      "logo": "<string>",
      "swapsXyzCode": "<string>",
      "usdAmount": 123
    }
  },
  "usdRates": {
    "timestamp": 123,
    "srcToken": 123,
    "dstToken": 123
  },
  "workflow": {
    "name": "polymarket",
    "operation": "placeOrder",
    "status": "success",
    "timestamp": 1763996274,
    "data": {
      "userId": "0x0797bfec6d2d4f733d461bbee8125805e9e9c892",
      "orderRequest": {
        "tokenID": "110902308091723190012269532299497167125504426554890434343419495764557291673806",
        "feeRateBps": 0,
        "slippage": 100,
        "negRisk": true,
        "amount": 5,
        "price": 0.021,
        "size": 5
      },
      "orderResponse": {
        "id": "0xbd2f3c625c1f6f918a74e8645c3afee9e8f2c5adf91f178efa5e1b65f74fb489",
        "status": "MATCHED",
        "owner": "258f7485-b93f-52e5-2327-a53c49a299c1",
        "maker_address": "0xBEDcAD563ddf52391573a016Bc5EC7A334Eec756",
        "market": "0xb050c89e1e5738c79e117d28da1f057ac2f193511aab87a01b517b466c7265dc",
        "asset_id": "110902308091723190012269532299497167125504426554890434343419495764557291673806",
        "original_size": "5",
        "size_matched": "0",
        "price": "0.02",
        "outcome": "No",
        "expiration": "1763996360",
        "order_type": "GTD",
        "associate_trades": [
          "<string>"
        ],
        "created_at": 1763996291
      },
      "relayTx": {
        "txHash": "<string>",
        "status": "<string>"
      }
    }
  },
  "org": {
    "appId": "0xb38801d6",
    "appName": "Box Examples / Scenarios",
    "affiliateId": "0x00000000"
  },
  "usdValue": 100.5,
  "srcTx": {
    "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "chainId": 1,
    "timestamp": 1765593607,
    "toAddress": "0x38630c8ec92494cf96ded12060d8136b75e7a8b5",
    "value": "0",
    "paymentToken": {
      "name": "Ethereum",
      "symbol": "ETH",
      "decimals": 18,
      "amount": "1000000000000000000",
      "chainId": 137,
      "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
      "isNative": false,
      "usdAmount": 4.00687776
    },
    "revertReason": "<string>"
  },
  "dstTx": {
    "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "chainId": 1,
    "timestamp": 1765593607,
    "toAddress": "0x38630c8ec92494cf96ded12060d8136b75e7a8b5",
    "value": "0",
    "paymentToken": {
      "name": "Ethereum",
      "symbol": "ETH",
      "decimals": 18,
      "amount": "1000000000000000000",
      "chainId": 137,
      "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
      "isNative": false,
      "usdAmount": 4.00687776
    },
    "revertReason": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Limited demo key for API Reference: 5c951bc81da566bbd030ba8e20724063.

Query Parameters

​
txHash
string

Transaction hash to query (required if txId not provided)

Example:

"0xd56968cf4fede6a0773f3e6dfad7d1088aacd3994bada55d44faee9596dadff2"

​
txId
string

Transaction ID to query (required if txHash not provided)

Example:

"0x49b1d3d38176e45864fd55500c6c1879ab318609e1ed0c8eb9abd818e6c811fd"

​
chainId
integer

Source chain ID for the transaction (optional but recommended)

Example:

1

Response

200 - application/json

Transaction status response

​
status
enum<string>
required

Status of the transaction

Available options:
success,
pending,
requires refund,
refunded,
failed,
not yet created,
expired,
submitted,
completed
Example:

"success"

​
sender
string
required

Sender wallet address

Example:

"0x1234567890123456789012345678901234567890"

​
srcChainId
integer
required

Source chain ID

Example:

1

​
bridgeDetails
object
required
​
txId
string
required

Unique transaction identifier

Example:

"0x49b1d3d38176e45864fd55500c6c1879ab318609e1ed0c8eb9abd818e6c811fd"

​
dstChainId
integer | null

Destination chain ID

Example:

42161

​
srcTxHash
string | null

Source transaction hash

Example:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

​
dstTxHash
string | null

Destination transaction hash

Example:

"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"

​
actionRequest
object

Original action request parameters

​
actionResponse
object

Original action response data

​
usdRates
object | null

USD rates at the time of the transaction

​
workflow
object | null

Workflow information if transaction is associated with a workflow (only present if the transaction had a workflow)

​
org
object | null
​
usdValue
number | null

USD value of the transaction

Example:

100.5

​
srcTx
object | null
​
dstTx
object | null