Swap Rate

This endpoint allows you to fetch real-time swap rates for cryptocurrency pairs supported by OxaPay. It’s ideal for applications that need the latest cryptocurrency prices to ensure accurate and timely calculations.

POST https://api.oxapay.com/v1/general/swap/rate

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.

Request Body

Name	Type	Description
from_currency*	string	Specify the currency symbol you want to swap from.
to_currency*	string	Specify the currency symbol you want to swap to.

200: OK

{
  "data": {
    "rate": "decimal", // The swap rate between the "from_currency" and "to_currency" at the time of the request (e.g., 1 BTC = 94763.06000000 USDT).
  },
  "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.

API Request Sample Codes

cURL

curl -X POST https://api.oxapay.com/v1/general/swap/rate \
  -H "general_api_key: YOUR_GENERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_currency": "USDT",
    "to_currency": "TRX"
  }'

PHP

<?php

$url = 'https://api.oxapay.com/v1/general/swap/rate';

$data = [
    "from_currency" => "USDT",
    "to_currency" => "TRX"
];

$headers = [
    'Content-Type: application/json',
    'general_api_key: YOUR_GENERAL_API_KEY'
];

$options = array(
    'http' => array(
        'header'  => implode("\r\n", $headers),
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
if ($response === FALSE) {
    die('Error occurred');
}

$result = json_decode($response, true);
var_dump($result);

?>

Node.js

const axios = require('axios');

const url = 'https://api.oxapay.com/v1/general/swap/rate';

const data = {
  from_currency: "USDT",
  to_currency: "TRX",
};

const headers = {
  'general_api_key': `YOUR_GENERAL_API_KEY`,
  'Content-Type': 'application/json',
};

axios.post(url, data, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import json

url = 'https://api.oxapay.com/v1/general/swap/rate'

data = {
    "from_currency": "USDT",
    "to_currency": "TRX"
}

headers = {
    'general_api_key': 'YOUR_GENERAL_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.post(url, data=json.dumps(data), headers=headers)
result = response.json()
print(result)

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

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

API Response Example

{
    "data": {
        "rate": 94763.06000000
    },
    "message": "Operation completed successfully!",
    "error": {},
    "status": 200,
    "version": "1.0.0"
}

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.