Exchange History

Use this endpoint to retrieve a list of exchange transactions for a specific business. The list can be filtered by various criteria, such as time range, currency, type (autoConvert or manualSwap or swapByApi), and more. Pagination is also available to fetch the results in smaller sets.

POST https://api.oxapay.com/exchange/list

Request Body

Name	Type	Description
key*	string	Your General API key for authentication and authorization.
orderBy	string	Display the list in ascending or descending order. Possible values: 'asc', 'desc' [default 'desc'].
sortBy	string	Sort the received list by a parameter. Set to 'create_date' by default. Possible values: 'create_date', 'pay_date', 'amount' [default 'create_date'].
page	integer	The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1.
size	integer	Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10.
type	string	Filter exchanges based on type (autoConvert or manualSwap or swapByApi).
toCurrency	string	Specify the currency symbol for filtering exchanges in a specific toCurrency.
fromCurrency	string	Specify the currency symbol for filtering exchanges in a specific fromCurrency.
toDate	string	The start of the date window to query for exchanges in unix format
fromDate	string	The start of the date window to query for exchanges in unix format
trackId	integer	Filter spesific exchange by it`s trackId

200: OK

{
  "result": integer, // The result code indicates the success or failure of the request.
  "message": string, // A message providing additional information about the result.
  "data": [
    {
      "trackId": string, // The uniqe id for the exchange.
      "fromCurrency": string, // The currency code of the cryptocurrency you want to convert from
      "toCurrency": string, // The currency code of the cryptocurrency you want to convert to
      "fromAmount": string, // Amount you want to exchange
      "toAmount": string, // The amount you'll receive in your desired cryptocurrency.
      "rate": string, // The real-time exchange rate representing the number of units of `fromCurrency` equivalent to `toCurrency`.
      "type": string, // The type of the exchange (e.g., \"autoConvert\" or \"manualSwap\" or \"swapByApi\").
      "date": string, // The timestamp of the exchange transaction in Unix time format.
    }
  ],
  "meta": {
    "size": integer, // The number of exchange transactions returned in the current page.
    "page": integer, // The current page number of the result set.
    "pages": integer, // The total number of pages available based on the number of records and page size.
    "total": integer // The total number of exchange transactions available for the specified criteria.
  }
}

Please note that this response sample includes a list of exchange transactions with their respective details and a metadata section providing information about the total number of records and pages available.

Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding result codes for further details.

Example codes

cURL

curl -X POST https://api.oxapay.com/exchange/list \
  -d '{
    "key": "YOUR_GENERAL_API_KEY",
    "fromDate": 1690848000,
    "toDate": 1691625600,
    "size": 20,
    "page": 0
  }'

PHP

<?php

$url = 'https://api.oxapay.com/exchange/list';

$data = array(
    'key' => 'YOUR_GENERAL_API_KEY',
    'fromDate' => 1690848000,
    'toDate' => 1691625600,
    'size' => 20,
    'page' => 0
);

$options = array(
    'http' => array(
        'header' => 'Content-Type: application/json',
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
$result = json_decode($response);
var_dump($result);
?>

Node.js

const axios = require('axios');
const url = 'https://api.oxapay.com/exchange/list';
const data = JSON.stringify({
    key: 'YOUR_GENERAL_API_KEY',
    fromDate: 1690848000,
    toDate: 1691625600,
    size: 20,
    page: 0
});

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

Python

import requests
import json

url = 'https://api.oxapay.com/exchange/list'
data = {
  'key': 'YOUR_GENERAL_API_KEY',
  'fromDate': 1690848000,
  'toDate': 1691625600,
  'size': 20,
  'page': 0
}
response = requests.post(url, data=json.dumps(data))
result = response.json()
print(result)

Please remember to replace YOUR_GENERAL_API_KEY with your actual general API key and adjust the parameters as needed for your specific use case.