v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Main Account

Get deposit/withdraw history

The endpoint retrieves the history of deposits and withdraws.

Deposit status codes:

  • Successful - 3, 7
  • Canceled - 4, 9
  • Unconfirmed by user - 5
  • AML frozen - 21
  • Uncredited - 22
  • Pending - 15

Successful (3, 7) is a final state. A credited deposit does not later transition to AML frozen (21) or Uncredited (22); those checks happen before crediting.

Travel Rule Deposit check status codes:

  • Awaiting verification - 27: The transaction has been frozen due to the lack of data required under the Travel Rule. The user is required to provide this data manually through the exchange interface.
  • Confirmation in progress - 28: The Travel Rule data provided by the user is currently being verified by WhiteBIT.

⚠️ Due to regulatory requirements in Turkey and EU, the system places every inbound crypto deposit on hold (frozen) until confirming the transaction's origin. The sender must provide certain details if the transaction is from another Virtual Asset Service Provider (VASP) or verify the address if from a self-hosted wallet. The system credits deposited funds to the account only after successful verification.

Withdraw status codes:

  • Pending - 1, 2, 6, 10–17 (withdrawal in progress).
  • Successful - 3, 7
  • Canceled - 4
  • Unconfirmed by user - 5
  • AML frozen - 21
  • Partially successful - 18
<Warning> Rate limit: 200 requests/10 sec. </Warning> <Warning> Requests with `limit` values above 100 return large payloads. Use high limits only when necessary and ensure the client application can handle large response sizes. </Warning> <Note> The API does not cache the response. </Note> <Note> Results are sorted newest first (descending by timestamp). </Note> <Note> **No date filtering:** the endpoint does not accept `startDate` / `endDate` parameters, and pagination is capped at `offset + limit ≤ 10000` (requests beyond the cap return `Offset is too big. Please use offset + limit less than 10000.`). To read more than 10,000 records, narrow the result set with the available filters (`transactionMethod`, `ticker`, `status`) and paginate within each subset; for a complete history export beyond the cap, use the Report on the History page. </Note>
post/api/v4/main-account/history

Request body

transactionMethod1 | 2

Method. Example: 1 to display deposits / 2 to display withdraws. Do not send this parameter in order to receive both deposits and withdraws.

tickerstring

Currency's ticker. Example: BTC

addressstring

Can be used for filtering transactions by specific address.

memostring

Can be used for filtering transactions by specific memo

addressesstring[]

Can be used for filtering transactions by specific array of addresses.

unique_idstring

Can be used for filtering transactions by specific unique id

limitinteger

LIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 500

offsetinteger

Use the OFFSET clause to return entries starting from a particular line.

statusinteger[]

Can be used for filtering transactions by status codes.

⚠️ Caution: Use this parameter with the appropriate transactionMethod and valid status codes for that method. See the endpoint description above for valid codes. Example: "status": [3,7]

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "transactionMethod": 1,
  "ticker": "BTC",
  "address": "3ApEASLcrQtZpg1TsssFgYF5V5YQJAKvuE",
  "memo": "48565488244493",
  "addresses": [
    "3ApEASLcrQtZpg1TsssFgYF5V5YQJAKvuE"
  ],
  "unique_id": "24529041",
  "limit": 100,
  "status": [
    3,
    7
  ],
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

All validations succeeded and creating transaction is started

limitinteger
offsetinteger
totalinteger

Total number of transactions, use this for calculating 'limit' and 'offset'

Example response

{
  "records": [
    {
      "address": "3ApEASLcrQtZpg1TsssFgYF5V5YQJAKvuE",
      "createdAt": 1593437922,
      "currency": "Bitcoin",
      "ticker": "BTC",
      "method": 1,
      "amount": "0.0006",
      "fee": "0",
      "status": 15,
      "transactionHash": "3b49d7b8cf7a4d3c1234567890abcdef",
      "transaction_id": "5e112b38-9652-11ed-a1eb-0242ac120002",
      "confirmations": {
        "actual": 3,
        "required": 6
      }
    }
  ]
}