search

Swap Pairs2

This endpoint allows you to access a list of swappable cryptocurrencies along with their minimum swap amounts. It provides the available options for the from_currency and to_currency fields when performing cryptocurrency swaps. Whether you're swapping Bitcoin for Tether or Tether for Litecoin, this list ensures clarity on supported pairs and their minimum swap requirements, helping you plan seamless transactions.

GET https://api.oxapay.com/v1/general/swap/pairs

hashtag
Authentication

You must include the General API Key in the request header to authenticate your access to the API.

Name
Type
Description

general_api_key*

string

Your General API Key for authentication and authorization.

{
  "data": {
    "list": 
      {
        "from_currency": string, // The currency being swapped from, e.g., 'BTC' (Bitcoin).
        "to_currency": string, // The currency being swapped to, e.g., 'USDT' (Tether).
        "min_amount": decimal // The minimum amount of the "from_currency" required for the swap, represented with high precision (e.g., 0.01 BTC).
      }[],
    "meta": {
      "page": integer, // The current page number of the result set.
      "last_page": integer, // The total number of pages available based on the number of records and page size.
      "total": integer // The total number of payments available for the specified criteria.
    },
  },
  "message": string,  // A message containing additional information about the result of the request.
  "error": {
      "type": string, 
      "key": string, 
      "message": string 
  } || {}, // An object that provides details about any errors that occurred.
  "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).
  "version": string // The version of the API being used.
}

Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding error for further details.

hashtag
API Request Sample Codes

These example code snippets demonstrate how to request the "Swap Calculate" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

circle-info

Please make sure to replace YOUR_GENERAL_API_KEY in the code snippets with your actual General API Key.

hashtag
API Response Example

The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager.

Last updated