v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

Get a list of swap transactions

[Available in Production/Sandbox environment] Get a list of swap transactions created using Swap API.

get/swap/transactions

Query parameters

filter[customerProfileId]string

Filter by customer profile id to return all swap transactions with customerProfileId passed in. Regex: /^(?!\s*$).+$/

filter[transactionId]string

Filter by the unique id of the swap transaction Regex: /^(?!\s*$).+$/

filter[idempotencyId]string

Filter by the idempotency id of the swap transaction Regex: /^(?!\s*$).+$/

filter[createdAfter]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

filter[createdBefore]string

ISO8601 format in UTC e.g. 2024-03-27T10:59:53Z Regex: /^(\d{4})(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\d|3[01])(T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(\.\d+)?(Z|([+-]([01]\d|2[0-3]):([0-5]\d)))?)?)?)?$/i

page[size]integer

Number of transactions per page(Must be an integer greater than 0) Regex: /^0*[1-9][0-9]*$/

page[number]integer

Page number(Must be an integer greater than 0) Regex: /^0*[1-9][0-9]*$/

sortstring

Sorted by Creation Date: Ascending (createdAt) / Descending (-createdAt)

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Response

200

Example response

{
  "data": [
    {
      "id": "contract_ff8c902f245f4124b1f28bed306f9b8b",
      "type": "swapTransaction",
      "attributes": {
        "idempotencyId": "sang_test3",
        "quoteId": "8185705a-857d-4e0c-a0e0-8453b3cf4929",
        "status": "pending",
        "swapPair": "XSGDUSDC",
        "sourceCurrency": "XSGD",
        "targetCurrency": "USDC",
        "fixedSide": "target",
        "totalSourceCurrencyAmount": "13318.25",
        "sourceCurrencyAmount": "13304.95",
        "targetCurrencyAmount": "10000.0",
        "rate": "0.7516",
        "fees": [
          {
            "type": "TransactionFee",
            "amount": "13.3",
            "currency": "XSGD"
          }
        ],
        "createdAt": "2024-04-03T13:56:05.219+08:00",
        "updatedAt": "2024-04-03T13:56:11.750+08:00"
      }
    }
  ],
  "meta": {
    "total": 3,
    "pages": 2
  },
  "links": {
    "self": "https://stx-api-gamma.dev.straitsx.com/api/v3/swap/transactions?page[size]=10",
    "next": "https://stx-api-gamma.dev.straitsx.com/api/v3/swap/transactions?page[number]=2&page[size]=10",
    "last": "https://stx-api-gamma.dev.straitsx.com/api/v3/swap/transactions?page[number]=2&page[size]=10"
  }
}