> ## 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 IOI advertisements (public board data)

> Query IOI advertisements (public board data)



## OpenAPI

````yaml openapi.oms.en.json GET /api/v1/util/ioi/advertisements
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: Account authentication and password recovery.
  - 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/ioi/advertisements:
    get:
      tags:
        - Trading
      summary: Query IOI advertisements (public board data)
      description: >-
        Returns IOI advertisement board data. Requires `Authorization: Bearer
        <jwt>` from `POST /api/auth/login`.
      operationId: listIoiAdvertisements
      parameters:
        - name: symbol
          in: query
          schema:
            type: string
          description: Optional trading symbol filter.
        - name: status
          in: query
          schema:
            type: string
          description: Optional status filter.
        - name: side
          in: query
          schema:
            type: string
          description: Optional side filter.
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: IOI advertisements result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IOIResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
      servers:
        - url: https://api-oms.verolabs.co
components:
  parameters:
    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:
    IOIResult:
      type: object
      properties:
        symbol:
          type: string
          description: Trading symbol.
        status:
          type: string
          description: Status value returned by the API.
        side:
          type: string
          description: Order or quote side.
        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.
        advertisements:
          type: array
          items:
            $ref: '#/components/schemas/Advertisement'
          description: IOI advertisement records returned for the current page.
      description: IOI advertisement query response.
    Advertisement:
      type: object
      description: IOI advertisement record.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the record.
        rawMessageID:
          type: integer
          format: int64
          nullable: true
          description: Message identifier.
        receivedAt:
          type: string
          format: date-time
          description: Timestamp when the record was received.
        ioiId:
          type: string
          description: IOI identifier.
        ioiRefId:
          type: string
          description: Referenced IOI identifier.
        broker:
          type: string
          description: Broker identifier.
        symbol:
          type: string
          description: Trading symbol.
        side:
          type: string
          description: Order or quote side.
        qty:
          type: integer
          format: int64
          description: Quantity value for the request.
        price:
          type: number
          format: double
          description: Price value for the request or record.
        transType:
          type: string
          description: Transaction type.
        repoHaircutRatio:
          type: number
          format: double
          description: Repo haircut ratio.
        collateralValue:
          type: number
          format: double
          description: Collateral value.
        contactNo:
          type: string
          description: Contact number.
        status:
          type: string
          description: Status value returned by the API.
        rejReason:
          type: integer
          description: Rejection reason.
        sourceSeq:
          type: integer
          format: int64
          description: Source sequence number for ordering updates.
        createdAtNs:
          type: integer
          format: int64
          description: Creation timestamp in epoch nanoseconds.
    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'
    ServerError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````