Get deposit history [Private]

Get a list of client's deposits. Returns a list of deposit objects, newest first, 100 deposits maximum, but not more than specified by the limit parameter.


To call any private endpoint, headers should include authorization key(s).

You may use a single API key or a public-private key pair based on your current tasks. Here you may find typical Header configurations for both options.

Method name:/v4/deposit/private/history
Request type:GET

Data dictionary

NameTypeParameter typeRequiredRangeDescription
currencystringQUERYNO-Cryptocurrency code. All available cryptocurrency assets are available through "Get information about available currencies" endpoint.
statusenumQUERYNOCreated, Canceled, PartiallyProcessed, Processing, Processed, WaitForConfirmation, Pending, AmlCheckingFilter by status.
dateFromstringQUERYNO-Show transactions after a specified date (ISO format).
dateTostringQUERYNO-show transactions until a specified date (ISO format).
sortFieldenumQUERYNOamount, createdAtamount - sorting by time; createdAt - sorting by date.
sortOrderenumQUERYNOasc, descSort the resulting list newest-on-top (desc) or oldest-on-top (asc). Parameter sort defaults to desc if not provided.
takeintQUERYNO1 - 100Select the number of transactions. The default return is 20 transactions.
skipintQUERYNO1 - ...Select the number of transactions to skip. The default is 0 transactions to skip.
addressstringQUERYNO-Deposit address.


take and skip fields:

The maximum number of transactions you can get at one time is 100. If you have more than 100 transactions, you need to use the take and skip fields.

For example, you have 300 transactions:

  • at the first call, we get the first 100 transactions: /v4/deposit/private/history?currency=USDT&take=100&skip=0;
  • to get the second array of the next 100 transactions: /v4/deposit/private/history?currency=USDT&take=100&skip=100;
  • to get the third array of 100 transactions: /v4/deposit/private/history?currency=USDT&take=100&skip=200.

Exemplary request

Example pathDescription
/v4/deposit/private/history?status=Processed&take=10Returns the last 10 successful transactions.
/v4/deposit/private/history?currency=XRP&take=10Returns the last 10 XRP transactions with all statuses.
/v4/deposit/private/history?currency=USDT&status=Processed&dateFrom=2023-06-01T00%3A00%3A00.000Z&dateTo=2023-06-10T00%3A00%3A00.000Z&sortField=amount&sortOrder=ascReturns successful transactions from 01.06.2023 to 10.06.2023 sorted by amount from less to more.
const apiKey = "YOUR_API_KEY"; // put here your Api key

const url = "";
const path = "/v4/deposit/private/history?status=Processed&take=10";
const options = {
  method: "GET",
  headers: {
    accept: "application/json",
    "Content-Type": "application/json",
    "api-key": apiKey,

fetch(url + path, options)
    .then((response) => response.json())
    .then((showResponse) => console.log(;
import requests

api_key = "YOUR_API_KEY"  # put here your Api key

url = ""
path = "/v4/deposit/private/history?status=Processed&take=10"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "api-key": api_key,

request = requests.get(url + path, headers=headers)

How to call private endpoints here

Swagger here


      "id": "a201cb3c-5830-57ac-ad2c-f6a588dd55eb",                               // Unique ID of deposit
      "amount": "9.9",                                                            // Amount credited to your account
      "asset": "USDT",                                                            // Deposit currency
      "merchantId": "16214228-5c0c-5abc-be6a-c90259b21d4e",                       // Internal ID (not for use)
      "paymentCode": "TRX",                                                       // Blockchain name
      "status": "Processed",                                                      // Transactions status
      "type": "Deposit",                                                          // Transaction type
      "reason": [],                                                               // Reason for manual transaction processing
      "address": "TNeBQz8RyGGiAYAR7r8G6QGxtTWDkpH4dV",                            // Deposit address
      "memo": "",                                                                 // Deposit memo
      "txId": "8a0b0c5a2ac5679879b71b2fa63b0a5c39f90bc8ff6c41e708906b398ac3d4ef", // Deposit transaction hash
      "fee": "0.1",                                                               // Deposit fee
      "processedAmount": "10",                                                    // Amount of deposit
      "createdAt": "2023-06-13T12:55:01.256Z",                                    // Deposit receipt date
      "updatedAt": "2023-06-13T12:55:01.696Z"                                     // Deposit credit date
      "id": "f14eea95-b91a-528f-88b2-ce75ff17ebf7",
      "amount": "49.2525",
      "asset": "XRP",
      "merchantId": "16214228-5c0c-5abc-be6a-c90259b21d4e",
      "paymentCode": "XRP",
      "status": "Processed",
      "type": "Deposit",
      "reason": [],
      "address": "rEZnowWMyrY8YoGwLatyPBxx8QkJeimgAb",
      "memo": "2097352605",
      "txId": "3A06107DD81885AD1F3A21EAC3851D63752E5B6FD17E095AD678EF1A2C675181",
      "fee": "0.4975",
      "processedAmount": "49.75",
      "createdAt": "2023-06-13T12:16:47.014Z",
      "updatedAt": "2023-06-13T12:16:47.344Z"