Skip to content

Get Orders (Bulk Orders)

Request

Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer.

Security
sec0
Query
start_datestring, (date)required

Start date used for filtering orders. Must be a date in the format YYYY-MM-DD.

Default:"2021-01-18"
end_datestring, (date)required

End date used for filtering orders. Must be a date in the format YYYY-MM-DD.

Default:"2021-01-19"
statusstring

Current status of an order. Can be one or many order statuses which are comma separated. Available order statuses can be found here: Order Status

Default:"inProgress,coinTransferred,declined"
per_pageinteger, (int32)

Number of orders returned in a single response. The maximum is 200.

Default:100
pageinteger, (int32)

Page to retrieve. The number of pages available is given in the meta object in the response.

account_referencestring

Customer reference that was passed as a parameter when creating an order. Used to retrieve all orders for a customer.

Headers
Acceptstring
Default:"application/json"
X-Request-Idstring

This is the correlation ID related to the request.

curl -i -X GET \
  'https://docs.banxa.com/_mock/products/legacy-api/openapi/api/orders?start_date=2021-01-18&end_date=2021-01-19&status=inProgress%2CcoinTransferred%2Cdeclined&per_page=100&page=0&account_reference=string' \
  -H 'Accept: application/json' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-Request-Id: string'

Responses

200

Bodyapplication/json
dataobject
metaobject
Response
{
  "data": {
    "orders": [ … ]
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}
© Banxa 2026