Skip to main content

Order list

Get a list of orders.

Request

To get an order list, use the following API call:

POST /v2/order/list
POST /v2/order/list HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"currency_from": "usdt", //optional
"network_from": "trc20", //optional
"currency_to": "btc", //optional
"network_to": "btc", //optional
"date_from": "1970-01-01 00:00:00", //optional
"date_to": "2030-01-01 00:00:00", //optional
"order_type": "deposit", //optional
"status": "new", //optional
"limit": 100, //optional, from 1 to 1000
"page": 1, //optional
"order_id": "merchant_unique_order_id", //optional
"order_ids": ["merchant_unique_order_id"] //optional, array of order ids
}
Note

All parameters are optional, the response contains up to 1000 orders.

Description of parameters in the request:

  • currency_from – Deposit or exchange currency
  • network_from – Deposit network
  • currency_to – Currency of withdrawal or exchange result
  • network_to – Withdrawal network
  • date_from – Select from this order creation date
  • date_to – Select up to this order creation date
  • order_type – Order type
  • status – Order status (see order status section for details)
  • order_id – Unique payment identifier in the merchant system
  • order_ids – Array of unique payment identifiers in the merchant system
  • limit – Number of orders in response, available from 1 to 1000 (default 100)
  • page – Page number from which to start issuing results, 1 or more (one page contains limit orders)

Response

RESPONSE
HTTP/1.1 200 OK
Content-Type: application/json

{
"status": "success",
"data": [
{
"order_uuid":"3e7d0f84-d655-4069-991c-ad4739874ca5",
"order_type":"deposit_exchange_withdraw",
"user_order_id":"merchant_unique_order_id",
"description": null,
"expected_amount_from":"29",
"amount_from":null,
"currency_from":"usdt",
"network_from":"trc20",
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"0.00103988",
"amount_to":null,
"strict_withdrawal_amount": false | true,
"currency_to":"btc",
"network_to":"btc",
"withdraw_to_user": null,
"wallet_to":"2N9MQVd2rQZF9TEE3SXHzjvBUNgFWr2qf6V",
"wallet_memo_to":null,
"wallet_to_details": null | {},
"wallet_to_transactions": [],
"amount_from_fee":null,
"amount_to_fee":"0",
"deposit_url":null,
"deposit_address":"TVb4KtWABb9vyzMhiLm3cgFaE11MCZfvQu",
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":"0.000035858",
"exchange_rate_actual":null,
"status":"new",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 19:17:37",
"updated_at":"1970-01-01 19:17:38",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 2,
"currency_to_precision": 8,
"balance_changes": [
{
"currency": "usdt",
"amount_before": "1013",
"amount_change": "-13",
"amount_after": "1000",
"created_at": "1970-01-01 19:17:38"
}
]
}
]
}

The data field of the response contains an array of found orders. See order status section for details about single order data.

additional parameter in response

balance_changes - In case of changes in the user's wallet balances when executing an order, the changes are reflected here as an array of objects with the fields currency, amount_before, amount_change, amount_after, created_at