Skip to main content
GET

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPAY.

Query Parameters

page_number
integer
default:1

The page number to retrieve.

Required range: 1 <= x <= 1000000
page_size
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100
symbol
string

Filter by asset symbol.

Maximum string length: 32
asset_id
string<uuid>

Asset identifier returned by List assets.

client_reference
string

Filter by the reference supplied when creating the order.

Required string length: 1 - 100
order_status
enum<string>

Filter by the public order processing state.

Available options:
PENDING,
SUCCESS,
FAILED
from
string<date-time>

Inclusive start of the creation-time window. When both are provided, from must be earlier than to.

to
string<date-time>

Exclusive end of the creation-time window. When both are provided, from must be earlier than to.

Response

Success

data
object[]
required

Items on this page. An empty array can indicate no matches or a page beyond the last result.

total_pages
integer<int64>
required

Number of result pages for the requested page size.

Required range: x >= 0
Example:

1

total_items
integer<int64>
required

Number of matching items across all pages.

Required range: x >= 0
Example:

1