List Orders

Retrieves full details of orders associated with a Profile ID, with optional filters.

• Historical data prior to May 16, 2022 is unavailable.
• Pagination Limit has a max of 1000. Pagination Offset is now deprecated and nonfunctional.
• Filtering options are account_id, profile_id or neither (all orders).

GET /orders

List Orders

cURL

curl --request GET \
  --url https://api.paxos.com/v2/orders \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
      "ref_id": "my-order-1",
      "status": "FILLED",
      "market": "ETHUSD",
      "side": "BUY",
      "type": "LIMIT",
      "price": "190.23",
      "base_amount": "2.35781498",
      "quote_amount": "0",
      "metadata": {
        "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339"
      },
      "amount_filled": "2.35781498",
      "volume_weighted_average_price": "190.23",
      "time_in_force": "GTC",
      "is_triggered": false
    },
    {
      "id": "81e26e1d-eddb-455a-8b44-e3d845432de7",
      "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
      "ref_id": "my-order-2",
      "status": "FILLED",
      "market": "BTCUSD",
      "side": "BUY",
      "type": "MARKET",
      "price": "0",
      "base_amount": "0",
      "quote_amount": "500.00",
      "metadata": {
        "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339"
      },
      "amount_filled": "0.05142181",
      "volume_weighted_average_price": "9723.50",
      "time_in_force": "FOK",
      "is_triggered": false
    }
  ],
  "next_page_cursor": "CgsIxom6iQYQwO39XBDbsdVz"
}

OAuth Scope

exchange:read_order

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

profile_id · string

The profile associated with the orders.

account_id · string

The account under which these orders are placed.

market · enum<string>

Filter by the trading pair.

Available options: ETHEUR, ETHSGD, ETHUSD, BTCEUR, BTCSGD, BTCUSD, PAXGUSD, BCHUSD, LTCUSD, USDPUSD, LINKUSD, MATICUSD, AAVEUSD, UNIUSD

status · enum<string>

Filter by the status of the order.

Available options: PENDING_SUBMISSION, SUBMITTED, OPEN, FILLED, CANCELLED, REJECTED

order_time.begin · string<date-time>

Only return records after this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z.

order_time.end · string<date-time>

Only return records before this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z.

ref_ids · string[]

The idempotence IDs provided during order creation.

page_cursor · string

Cursor token for fetching the next page. If using this then do not use paginationLimit and paginationOffset fields.

limit · integer<int32>

Number of results to return. If using this then do not use paginationLimit and paginationOffset fields.

Response

200 - application/json

A successful response.

items · object[]

Show child attributes

next_page_cursor · string

Cursor token required for fetching the next page.