> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vos.verolabs.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Query orders (caller-scoped)

> Query orders (caller-scoped)



## OpenAPI

````yaml openapi.oms.vi.json GET /api/v1/util/orders
openapi: 3.0.3
info:
  title: VOS OMS Public API
  version: 1.0.0
  description: >-
    Public REST API surface for Vero OMS. Authentication requests use
    platform.verolabs.co. REST API requests use api-oms.verolabs.co.
servers:
  - url: https://platform.verolabs.co
    description: Authentication host
  - url: https://api-oms.verolabs.co
    description: REST API host
security: []
tags:
  - name: Authentication
    description: Xác thực tài khoản và khôi phục mật khẩu.
  - name: Trading
    description: Order entry, quote, IOI, and trading activity APIs.
  - name: Portfolio & Risk
    description: Accounts, holdings, mappings, and risk-rule read APIs.
  - name: Administration
    description: Permissions, groups, workflow, reference data, and audit APIs.
  - name: System & Diagnostics
    description: Health and latency endpoints.
paths:
  /api/v1/util/orders:
    get:
      tags:
        - Trading
      summary: Query orders (caller-scoped)
      description: >-
        Returns order records scoped to the accounts the caller can access. A
        caller with no account grants receives an empty page. `from_ns` and
        `to_ns` filter by order creation timestamp (`create_unix_utc_time_ms`).


        Requires `Authorization: Bearer <jwt>` from `POST /api/auth/login`.
      operationId: get_api_v1_util_orders
      parameters:
        - name: order_id
          in: query
          schema:
            type: string
          description: Optional order identifier filter.
        - name: original_req_id
          in: query
          description: >-
            Filter by the order stable entry key. Trade records use the same
            value in `original_req_id`, which can be used to match orders and
            trades.
          schema:
            type: string
        - name: orig_cl_ord_id
          in: query
          description: Filter by the originating client order id.
          schema:
            type: string
        - name: account_id
          in: query
          description: >-
            Optional refinement. Must be one of the caller's permitted accounts
            — a request for an

            account the caller has no grant on is rejected with 403.
          schema:
            type: string
        - name: symbol
          in: query
          schema:
            type: string
          description: Optional trading symbol filter.
        - name: order_status
          in: query
          schema:
            type: string
          description: Optional order status filter.
        - $ref: '#/components/parameters/FromNs'
        - $ref: '#/components/parameters/ToNs'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Orders result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrdersResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
      servers:
        - url: https://api-oms.verolabs.co
components:
  parameters:
    FromNs:
      name: from_ns
      in: query
      description: Start of the time window as epoch nanoseconds.
      schema:
        type: integer
        format: int64
    ToNs:
      name: to_ns
      in: query
      description: End of the time window as epoch nanoseconds.
      schema:
        type: integer
        format: int64
    Limit:
      name: limit
      in: query
      description: Page size. Defaults to 200; capped by the per-API max limit.
      schema:
        type: integer
        minimum: 1
    Offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
      description: Zero-based number of records to skip.
  schemas:
    OrdersResult:
      type: object
      properties:
        order_id:
          type: string
          description: Order identifier.
        account_id:
          type: string
          description: Trading account identifier.
        symbol:
          type: string
          description: Trading symbol.
        order_status:
          type: string
          description: Order status filter.
        limit:
          type: integer
          description: Maximum number of records returned.
        offset:
          type: integer
          description: Zero-based number of records skipped before returning results.
        count:
          type: integer
          description: Number of records in the response page or aggregation.
        orders:
          type: array
          items:
            $ref: '#/components/schemas/Order'
          description: Order records returned for the current page.
      description: Order query response.
    Order:
      type: object
      description: Order record snapshot.
      properties:
        originalReqID:
          type: string
          description: Stable original request identifier for the order lifecycle.
        rawMessageID:
          type: integer
          format: int64
          nullable: true
          description: Message identifier.
        receivedAt:
          type: string
          format: date-time
          description: Timestamp when the record was received.
        sourceSeq:
          type: integer
          format: int64
          description: Source sequence number for ordering updates.
        orderID:
          type: string
          description: Order identifier assigned to the order.
        clOrdID:
          type: string
          description: Client order identifier.
        origClOrdID:
          type: string
          description: Original client order identifier for replace or cancel flows.
        accountID:
          type: string
          description: Trading account identifier.
        symbol:
          type: string
          description: Trading symbol.
        orderSide:
          type: string
          description: Order side reported by the order record.
        fixOrderSide:
          type: string
          description: FIX order side code.
        orderStatus:
          type: string
          description: Current order status.
        orderType:
          type: string
          description: Order type reported by the order record.
        fixOrdType:
          type: string
          description: FIX order type code.
        timeInForce:
          type: string
          description: Time-in-force code.
        board:
          type: string
          description: Trading board code.
        marketID:
          type: string
          description: Market identifier.
        user:
          type: string
          description: User identifier associated with the record.
        exchange:
          type: string
          description: Exchange code.
        ISIN:
          type: string
          description: ISIN or routed instrument identifier.
        originalPrice:
          type: number
          format: double
          description: Original order price.
        originalQty:
          type: integer
          format: int64
          description: Original order quantity.
        orderCurrentPrice:
          type: number
          format: double
          description: Current working order price.
        orderCurrentQty:
          type: integer
          format: int64
          description: Current working order quantity.
        filledQty:
          type: number
          format: double
          description: Filled quantity.
        avgFillPrice:
          type: number
          format: double
          description: Average fill price.
        cancelledQty:
          type: number
          format: double
          description: Cancelled quantity.
        orderText:
          type: string
          description: Free-form order text or reject reason.
        unixUTCTimeMs:
          type: number
          format: double
          description: Order update timestamp in Unix UTC milliseconds.
        createunixUTCTimeMs:
          type: number
          format: double
          description: Order creation timestamp in Unix UTC milliseconds.
        partyID:
          type: string
          description: Party identifier.
        partyTraderID:
          type: string
          description: Party trader identifier.
        quoteRespID:
          type: string
          description: Quote response identifier.
        quoteID:
          type: string
          description: Quote identifier.
        persisState:
          type: string
          description: Order state reported by the order record.
        algoID:
          type: string
          description: Algorithm identifier associated with the order.
        positionID:
          type: string
          description: Position identifier associated with the order.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code or error category.
        status:
          type: integer
          description: Status value returned by the API.
      description: Standard error response envelope.
  responses:
    BadRequest:
      description: Invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Caller is not permitted on the requested account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````