---
search:
  tags:
    - Orders
    - GET
seo:
  description: >-
    Returns a page of orders. A list filtered to resting and partially_filled
    only is served from the live… Reference for the GET /orders endpoint in the
    REST API.
sidebar:
  label: List Orders
  badge: GET
title: List Orders
type: openapi-operation
---
Returns a page of orders. A list filtered to resting and partially_filled only is served from the live working view. A list with no status filter or with any terminal status is served from history, which converges later. Without an account_id filter, or with several accounts in it, an account is included only after its setup and the setup of your access to it have both completed.

### Endpoint

- Method and path: `GET /orders`
- Operation ID: `listOrders`
- API reference: [GET /orders](/api-reference/rest/orders/list-orders)
- Complete specification: [OpenAPI (YAML)](/openapi.yml)
- Spec location (JSON Pointer): `#/paths/~1orders/get`

#### Authorization

- Accepted credentials: `UDX-Access-Key` header and `UDX-Access-Timestamp` header and `UDX-Access-Signature` header; or Bearer token in `Authorization`
- Details: [Authentication](/reference/authentication)

#### Parameters

```yaml
- $ref: "#/components/parameters/VersionHeader"
- name: client_order_id
  in: query
  required: false
  description: Filter by your correlation identifier.
  schema:
    $ref: "#/components/schemas/ClientId"
- name: ticker
  in: query
  required: false
  description: Filter by market ticker.
  schema:
    $ref: "#/components/schemas/Ticker"
- name: account_id
  in: query
  required: false
  description: Filter to these accounts. An account you cannot read matches no orders. Repeat the account_id parameter for each value.
  style: form
  explode: true
  schema:
    type: array
    description: Match any of the selected accounts.
    minItems: 1
    maxItems: 50
    items:
      $ref: "#/components/schemas/EntityId"
- name: status
  in: query
  required: false
  description: Select any single status; resting and partially_filled together; or filled, canceled, expired, and rejected together. Omit status or select every status for all orders. Other combinations return 400. Repeat the status parameter for each value.
  style: form
  explode: true
  schema:
    type: array
    description: Match any of the selected statuses.
    minItems: 1
    items:
      $ref: "#/components/schemas/OrderStatus"
- $ref: "#/components/parameters/TradingPaginationLimit"
- $ref: "#/components/parameters/PaginationPage"
```


#### Responses

##### `200`

A page of the caller's orders.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/json`

Schema:

```yaml
$ref: "#/components/schemas/OrdersListResponse"
```

Example: Example

```json
{
  "orders": [
    {
      "order_id": "BK9BZNTK8022",
      "client_order_id": "order-20260804-001",
      "account_id": "6820943174116859281",
      "ticker": "UDX-EXAMPLE-MARKET",
      "side": "buy",
      "quantity": "100",
      "price": "0.55",
      "time_in_force": "gtc",
      "status": "partially_filled",
      "filled_quantity": "40",
      "remaining_quantity": "60",
      "average_fill_price": "0.54",
      "fees_paid": "0.22",
      "created_at": "2026-01-01T00:00:00.000000Z"
    }
  ],
  "next_page_url": null
}
```

##### `400`

The request doesn't conform to this spec.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Invalid request parameters

```json
{
  "type": "urn:udx:problem:invalid-request-parameters",
  "title": "Bad Request",
  "status": 400,
  "detail": "invalid request parameters",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

Example: Unknown UDX-Version

```json
{
  "type": "urn:udx:problem:unknown-version",
  "title": "Bad Request",
  "status": 400,
  "detail": "unknown UDX-Version \"1999-01-01\"; supported versions: 2026-07-15",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `401`

No valid credential was provided.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Authentication failed

```json
{
  "type": "urn:udx:problem:invalid-authentication-credentials",
  "title": "Unauthorized",
  "status": 401,
  "detail": "invalid authentication credentials",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `403`

The credential lacks the read scope.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Insufficient permissions

```json
{
  "type": "urn:udx:problem:insufficient-permissions",
  "title": "Forbidden",
  "status": 403,
  "detail": "insufficient permissions",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `429`

The member rate limit was exceeded.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
Retry-After:
  $ref: "#/components/headers/RetryAfter"
Cache-Control:
  $ref: "#/components/headers/NoStore"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Example

```json
{
  "type": "urn:udx:problem:member-rate-limit-exceeded",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "this member has temporarily exceeded its request rate",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `500`

Something went wrong on UDX's side.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Internal server error

```json
{
  "type": "urn:udx:problem:internal-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `503`

Request admission or account setup is unavailable, or the read could not be completed in time; retry.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
Retry-After:
  $ref: "#/components/headers/RetryAfter"
Cache-Control:
  $ref: "#/components/headers/NoStore"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Caller setup is not ready

```json
{
  "type": "urn:udx:problem:projection-unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "account setup is still being completed; retry later",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

Example: Request admission is unavailable

```json
{
  "type": "urn:udx:problem:request-admission-unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "request admission is temporarily unavailable",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

Example: The read could not be completed in time

```json
{
  "type": "urn:udx:problem:could-not-process-retry",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "could not process request, please retry",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```


#### Referenced definitions

The references in the excerpts above resolve to these definitions in the complete specification.

##### `#/components/headers/VersionHeader`

```yaml
description: API version used for this response.
schema:
  type: string
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

##### `#/components/schemas/OrdersListResponse`

```yaml
type: object
description: A page of orders.
required:
  - orders
  - next_page_url
properties:
  orders:
    type: array
    maxItems: 100
    description: One page of orders.
    items:
      $ref: "#/components/schemas/Order"
  next_page_url:
    $ref: "#/components/schemas/NextPageURL"
```

##### `#/components/schemas/Order`

```yaml
type: object
additionalProperties: false
description: An order.
required:
  - order_id
  - account_id
  - ticker
  - side
  - quantity
  - price
  - time_in_force
  - status
  - filled_quantity
  - remaining_quantity
  - fees_paid
  - created_at
properties:
  order_id:
    $ref: "#/components/schemas/EntityId"
  client_order_id:
    $ref: "#/components/schemas/ClientId"
  account_id:
    type: string
    minLength: 1
    description: The account the order was placed under.
    example: "6820943174116859281"
  ticker:
    $ref: "#/components/schemas/Ticker"
  side:
    $ref: "#/components/schemas/OrderSide"
  quantity:
    $ref: "#/components/schemas/FixedPointQuantity"
  price:
    type: string
    pattern: ^[0-9]+(\.[0-9]{1,6})?$
    maxLength: 24
    description: Limit price in YES price space, in dollars, regardless of side.
    example: "0.55"
  time_in_force:
    $ref: "#/components/schemas/OrderTimeInForce"
  expires_at:
    type: string
    format: date-time
    maxLength: 40
    x-udx-timestamp-context: prospective
    description: When the order expires. Present only when time_in_force is gtt.
    example: 2026-01-01T00:01:00.000000Z
  status:
    $ref: "#/components/schemas/OrderStatus"
  rejection_reason:
    type: string
    enum:
      - duplicate_client_order_id
      - self_trade_prevented
      - market_closed
      - insufficient_funds
      - price_out_of_bounds
      - quantity_out_of_bounds
      - post_only_would_cross
      - no_liquidity
      - quote_unavailable
      - quote_terms_mismatch
      - quote_already_accepted
      - rate_limited
      - expires_at_invalid
      - exchange_rejected
    description: Why the exchange rejected the order. Present only when status is rejected.
  filled_quantity:
    type: string
    pattern: ^[0-9]+(\.[0-9]{1,2})?$
    maxLength: 24
    description: The quantity of the order that has been filled.
    example: "100"
  remaining_quantity:
    type: string
    pattern: ^[0-9]+(\.[0-9]{1,2})?$
    maxLength: 24
    description: The quantity of the order that is currently resting.
    example: "100"
  average_fill_price:
    type: string
    pattern: ^[0-9]+(\.[0-9]{1,6})?$
    maxLength: 24
    description: Volume-weighted average fill price. Present when filled_quantity > 0.
    example: "0.55"
  fees_paid:
    type: string
    pattern: ^[0-9]+(\.[0-9]{1,6})?$
    maxLength: 24
    description: Total fees collected on the order so far, in dollars.
    example: "0.55"
  created_at:
    type: string
    format: date-time
    maxLength: 40
    description: When the order was created.
    example: 2026-01-01T00:00:00.000000Z
```

##### `#/components/schemas/EntityId`

```yaml
type: string
minLength: 1
description: An exchange-assigned identifier. Treat it as an opaque, stable key with no internal structure.
example: "6820943174116859281"
```

##### `#/components/schemas/ClientId`

```yaml
type: string
description: A client-supplied correlation identifier.
example: client-20260804-001
```

##### `#/components/schemas/Ticker`

```yaml
type: string
minLength: 1
maxLength: 128
description: A human-meaningful natural key naming a single-leg or multi-leg market.
example: UDX-EXAMPLE-MARKET
```

##### `#/components/schemas/OrderSide`

```yaml
type: string
enum:
  - buy
  - sell
description: Order side.
```

##### `#/components/schemas/FixedPointQuantity`

```yaml
type: string
pattern: ^[0-9]+(\.[0-9]{1,2})?$
maxLength: 24
description: A quantity in contracts as a fixed-point decimal string.
example: "100"
```

##### `#/components/schemas/OrderTimeInForce`

```yaml
type: string
enum:
  - gtc
  - ioc
  - fok
  - day
  - gtt
  - unknown
description: Order time in force.
```

##### `#/components/schemas/OrderStatus`

```yaml
type: string
enum:
  - resting
  - partially_filled
  - filled
  - canceled
  - expired
  - rejected
description: An order's status.
```

##### `#/components/schemas/NextPageURL`

```yaml
type:
  - string
  - "null"
format: uri-reference
maxLength: 4096
pattern: ^/[^/\s#][^\s#]*$
description: Root-relative URL for the next page. Null when there are no more items.
example: /api_keys?limit=10&order=desc&page=eyJ2IjoxLCJzIjoiMjAyNi0wNi0wMVQxMjowMDowMC4wMDAwMDBaIiwiaWQiOiIzNTE3NDU2MjI5NjM0MTg1NjQ2In0&sort=created_at
```

##### `#/components/schemas/ProblemDetails`

```yaml
type: object
description: An RFC 9457 machine-readable error, returned on every non-2xx response. The response's Content-Language header identifies the language used by title and detail, and Vary includes Accept-Language.
required:
  - type
  - title
  - status
properties:
  type:
    type: string
    format: uri-reference
    maxLength: 2048
    description: A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.
  title:
    type: string
    maxLength: 40
    example: Bad Request
    description: A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.
  status:
    type: integer
    example: 400
    description: The HTTP status code, repeated from the response itself.
  detail:
    type: string
    maxLength: 500
    example: malformed request body
    description: A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.
  instance:
    type: string
    format: uri-reference
    maxLength: 100
    example: urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef
    description: An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.
```

##### `#/components/headers/RetryAfter`

```yaml
description: Whole seconds to wait before retrying.
schema:
  type: integer
  minimum: 1
  description: A positive delay in whole seconds.
  example: 2
```

##### `#/components/headers/NoStore`

```yaml
description: Prevents caching this response.
schema:
  type: string
  enum:
    - no-store
  description: Always the cache directive no-store.
  example: no-store
```

##### `#/components/parameters/VersionHeader`

```yaml
name: UDX-Version
in: header
required: false
description: Dated API version (YYYY-MM-DD).
schema:
  type: string
  minLength: 10
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

##### `#/components/parameters/TradingPaginationLimit`

```yaml
name: limit
in: query
required: false
description: Page size.
schema:
  type: integer
  minimum: 1
  maximum: 1000
  default: 10
  description: Page size.
  example: 10
```

##### `#/components/parameters/PaginationPage`

```yaml
name: page
in: query
required: false
description: Opaque token identifying the requested page.
schema:
  type: string
  maxLength: 512
  description: An opaque pagination cursor.
  example: eyJ2IjoxLCJzIjoiMjAyNi0wNi0wMVQxMjowMDowMC4wMDAwMDBaIiwiaWQiOiIzNTE3NDU2MjI5NjM0MTg1NjQ2In0
```