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

# Get a watchlist by id

> Get a watchlist by id



## OpenAPI

````yaml openapi.docs.en.json GET /api/v1/MarketData/GetWatchList/{watchlist_id}
openapi: 3.0.3
info:
  title: Vero OMS REST API
  version: 1.0.24
  description: >-
    REST API documentation for Vero OMS. Paths are aligned with the active
    KrakenD gateway config under k8s-dev-gitops/vero-algo/tools/krakend and
    response schemas are expanded from backend/frontend source models.
servers:
  - url: https://api-gw.verolabs.co
    description: API gateway
security: []
tags:
  - name: Auth
    description: Authentication flows and app logout
  - name: Signup
    description: APIs used during account signup
  - name: Accounts
    description: User accounts, balances, positions, deposits and withdrawals
  - name: Bank Accounts
    description: Saved bank account management
  - name: Orders
    description: Order placement, cancellation, modification and order history
  - name: History
    description: Account orders, trades and cash transactions.
  - name: Market Data
    description: Watchlists, symbol search, product master and OHLCV history
  - name: Notifications
    description: In-app notifications
  - name: Referral
    description: Referral code, rebate and commission summary APIs
  - name: Diagnostics
    description: Health and diagnostic endpoints
paths:
  /api/v1/MarketData/GetWatchList/{watchlist_id}:
    get:
      tags:
        - Market Data
      summary: Get a watchlist by id
      description: Get market-data watchlist by id/filter.
      operationId: getWatchList
      parameters:
        - name: watchlist_id
          in: path
          required: true
          schema:
            type: string
          description: Watchlist identifier used by the market-data service.
      responses:
        '200':
          description: Watchlist response with typed data payload.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                required:
                  - isSuccess
                  - data
                properties:
                  isSuccess:
                    type: boolean
                    description: Backend returned success flag.
                  returnCode:
                    oneOf:
                      - type: number
                      - type: string
                    description: >-
                      Backend return code; live success responses commonly
                      return 0.
                  serviceInstance:
                    type: array
                    items:
                      type: object
                      properties:
                        serviceType:
                          type: string
                          description: Backend service type that handled the request.
                        instanceID:
                          type: string
                          description: Backend service instance identifier.
                        lastUnixTime:
                          type: number
                          description: Latest service timestamp in Unix milliseconds.
                      additionalProperties: true
                    description: Market-data service instances that handled the request.
                  requestID:
                    type: string
                    description: Request id generated by the market-data service.
                  algoID:
                    type: string
                    description: Algo id echoed by the market-data service when supplied.
                  positionID:
                    type: string
                    description: >-
                      Position id echoed by the market-data service when
                      supplied.
                  requestType:
                    type: string
                    description: Backend request type label.
                  detail:
                    type: string
                    description: Backend detail message.
                  dataType:
                    type: string
                    description: Backend payload type label.
                  executionTime:
                    type: number
                    description: Backend execution time in milliseconds when available.
                  lastTime:
                    type: number
                    description: Last market-data timestamp returned by the service.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Watchlist identifier.
                      name:
                        type: string
                        description: Watchlist display name.
                      symbols:
                        type: array
                        items:
                          type: object
                          properties:
                            symbol:
                              type: string
                              description: Trading symbol code.
                            companyName:
                              type: string
                              description: Company or instrument display name.
                            sectorLvl1:
                              type: string
                              description: Level-1 sector classification.
                            sectorLvl2:
                              type: string
                              description: Level-2 sector classification.
                            sectorLvl3:
                              type: string
                              description: Level-3 sector classification.
                            industryName:
                              type: string
                              description: Industry name returned by market data.
                            logoId:
                              type: string
                              description: Logo identifier used by client assets.
                            news:
                              type: array
                              items:
                                type: object
                                additionalProperties: true
                                description: >-
                                  News item associated with the symbol when
                                  market-data service returns news.
                              description: News items associated with the symbol.
                            sentiment:
                              type: object
                              properties:
                                bullish:
                                  type: number
                                  description: Bullish sentiment score/count.
                                bullishPercent:
                                  type: number
                                  description: Bullish sentiment percentage.
                                bullishTime:
                                  type: number
                                  description: >-
                                    Timestamp or aggregation time for bullish
                                    sentiment.
                                bearish:
                                  type: number
                                  description: Bearish sentiment score/count.
                                bearishPercent:
                                  type: number
                                  description: Bearish sentiment percentage.
                                bearishTime:
                                  type: number
                                  description: >-
                                    Timestamp or aggregation time for bearish
                                    sentiment.
                              additionalProperties: true
                              nullable: true
                            info:
                              type: object
                              properties:
                                id:
                                  type: string
                                  description: Market-data instrument id.
                                seq:
                                  type: number
                                  description: Quote sequence number.
                                time:
                                  type: number
                                  description: Quote timestamp in Unix milliseconds.
                                symbol:
                                  type: string
                                  description: Trading symbol code.
                                boardID:
                                  type: string
                                  description: Exchange board id.
                                nomiPrc:
                                  type: number
                                  description: Reference or nominal price.
                                ceilPrc:
                                  type: number
                                  description: Ceiling price for the session.
                                floorPrc:
                                  type: number
                                  description: Floor price for the session.
                                lsPrc:
                                  type: number
                                  description: Last traded price.
                                lsVol:
                                  type: number
                                  description: Last traded volume.
                                openPrc:
                                  type: number
                                  description: Opening price.
                                closePrc:
                                  type: number
                                  description: Closing price when available.
                                highPrc:
                                  type: number
                                  description: Session high price.
                                lowPrc:
                                  type: number
                                  description: Session low price.
                                vWAP:
                                  type: number
                                  description: Volume-weighted average price.
                                totVol:
                                  type: number
                                  description: Total traded volume.
                                totVal:
                                  type: number
                                  description: Total traded value.
                                tradingSession:
                                  type: string
                                  description: Trading session code.
                                openInterest:
                                  type: number
                                  description: >-
                                    Open interest for derivatives when
                                    available.
                              additionalProperties: true
                              nullable: true
                            stat:
                              type: object
                              properties:
                                id:
                                  type: string
                                  description: Static instrument id.
                                symbol:
                                  type: string
                                  description: Trading symbol code.
                                type:
                                  type: string
                                  description: Instrument/security type.
                                lot:
                                  type: number
                                  description: Standard trading lot size.
                                minQty:
                                  type: number
                                  description: Minimum order quantity.
                                maxQty:
                                  type: number
                                  description: Maximum order quantity.
                                prcStep:
                                  type: number
                                  description: Minimum price tick size.
                                name:
                                  type: string
                                  description: Instrument short name.
                                productGroupID:
                                  type: string
                                  description: Product group id from the exchange.
                                tickerCode:
                                  type: string
                                  description: Ticker code used by the exchange.
                                symbolName:
                                  type: string
                                  description: Full symbol name when available.
                                underlyingSymbolCode:
                                  type: string
                                  description: >-
                                    Underlying symbol code for derivatives or
                                    structured products.
                                expirationDate:
                                  type: string
                                  description: >-
                                    Expiration date for derivatives when
                                    available.
                                contractSize:
                                  type: number
                                  description: >-
                                    Contract size for derivatives when
                                    available.
                              additionalProperties: true
                              nullable: true
                            depth:
                              type: object
                              properties:
                                seq:
                                  type: number
                                  description: Order book sequence number.
                                time:
                                  type: number
                                  description: Order book timestamp in Unix milliseconds.
                                symbol:
                                  type: string
                                  description: Trading symbol code.
                                boardID:
                                  type: string
                                  description: Exchange board id.
                                bidPriceDepth:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      prc:
                                        type: number
                                        description: Price level.
                                      vol:
                                        type: number
                                        description: Aggregated volume at the price level.
                                    additionalProperties: true
                                  description: Best bid price levels.
                                askPriceDepth:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      prc:
                                        type: number
                                        description: Price level.
                                      vol:
                                        type: number
                                        description: Aggregated volume at the price level.
                                    additionalProperties: true
                                  description: Best ask price levels.
                              additionalProperties: true
                              nullable: true
                            trend:
                              type: object
                              properties:
                                buyUp:
                                  type: object
                                  properties:
                                    symbol:
                                      type: string
                                      description: Trading symbol code.
                                    way:
                                      type: number
                                      description: Trade direction code.
                                    vwapPrice:
                                      type: number
                                      description: VWAP for this trend direction.
                                    totalValue:
                                      type: number
                                      description: Total traded value for this direction.
                                    totalVol:
                                      type: number
                                      description: Total traded volume for this direction.
                                    tradeCount:
                                      type: number
                                      description: Number of trades in this direction.
                                  additionalProperties: true
                                sellDown:
                                  type: object
                                  properties:
                                    symbol:
                                      type: string
                                      description: Trading symbol code.
                                    way:
                                      type: number
                                      description: Trade direction code.
                                    vwapPrice:
                                      type: number
                                      description: VWAP for this trend direction.
                                    totalValue:
                                      type: number
                                      description: Total traded value for this direction.
                                    totalVol:
                                      type: number
                                      description: Total traded volume for this direction.
                                    tradeCount:
                                      type: number
                                      description: Number of trades in this direction.
                                  additionalProperties: true
                                buyUpPct:
                                  type: number
                                  description: >-
                                    Percentage of volume/value classified as
                                    buy-up.
                                sellDownPct:
                                  type: number
                                  description: >-
                                    Percentage of volume/value classified as
                                    sell-down.
                                gapValue:
                                  type: number
                                  description: >-
                                    Difference between buy-up and sell-down
                                    traded value.
                              additionalProperties: true
                              nullable: true
                          additionalProperties: true
                        description: Symbols included in the watchlist.
                    additionalProperties: true
                    description: Watchlist object with id, name, and symbols.
        '400':
          $ref: '#/components/responses/ErrorResponse'
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyErrorBody'
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationProblemDetails'
                  - $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: string
                description: Plain-text backend or gateway error message.
        '401':
          $ref: '#/components/responses/ErrorResponse'
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyErrorBody'
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationProblemDetails'
                  - $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: string
                description: Plain-text backend or gateway error message.
        '404':
          $ref: '#/components/responses/ErrorResponse'
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyErrorBody'
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationProblemDetails'
                  - $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: string
                description: Plain-text backend or gateway error message.
        '500':
          $ref: '#/components/responses/ErrorResponse'
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyErrorBody'
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationProblemDetails'
                  - $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: string
                description: Plain-text backend or gateway error message.
      security: []
components:
  responses:
    ErrorResponse:
      description: Error response containing an error code, message, detail, or plain text.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
        text/plain:
          schema:
            type: string
  schemas:
    AnyErrorBody:
      oneOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - $ref: '#/components/schemas/ValidationProblemDetails'
        - $ref: '#/components/schemas/ProblemDetails'
        - $ref: '#/components/schemas/AuthFlow'
      description: >-
        Structured error body returned by gateway, ASP.NET services, or backend
        validation handlers.
    ValidationProblemDetails:
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
        - type: object
          additionalProperties: true
          properties:
            errors:
              type: object
              additionalProperties:
                oneOf:
                  - type: array
                    items:
                      type: string
                  - type: string
              description: Validation errors keyed by request field name.
      description: >-
        Validation problem response returned when request parameters or body
        fields are invalid.
    ProblemDetails:
      type: object
      additionalProperties: true
      description: RFC 7807-style problem response returned by ASP.NET/gateway services.
      properties:
        type:
          type: string
          description: Problem type URI.
        title:
          type: string
          description: Short problem title.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Detailed error message.
        traceId:
          type: string
          description: Trace id for backend diagnostics.
    ErrorResponse:
      type: object
      additionalProperties: true
      description: >-
        Error body returned by gateway or backend services. Backends can return
        either JSON objects or plain text errors.
      properties:
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
              properties:
                id:
                  type: string
                  description: gateway error id when supplied.
                code:
                  type: integer
                  description: HTTP-like error code.
                status:
                  type: string
                  description: HTTP status text, for example Unauthorized.
                reason:
                  type: string
                  description: >-
                    Detailed reason returned by the authentication service or
                    gateway.
                message:
                  type: string
                  description: Human-readable error message.
          description: Error code/message string or nested gateway error object.
        message:
          type: string
          description: Human-readable error message.
        detail:
          type: string
          description: Detailed backend error message when available.
        details:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
            - type: array
              items:
                type: object
                additionalProperties: true
          description: Additional validation or backend details.
          nullable: true
        status:
          type: integer
          description: HTTP status code when included by the backend.
    AuthFlow:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          description: >-
            Flow id. Use this value as the flow query parameter when submitting
            or updating the flow.
        type:
          type: string
          description: Flow type returned by the system, for example browser or api.
        expires_at:
          type: string
          format: date-time
          description: Timestamp when the flow expires. Submit the flow before this time.
        issued_at:
          type: string
          format: date-time
          description: Timestamp when created the flow.
        ui:
          type: object
          additionalProperties: true
          description: >-
            UI payload containing action URL, method, nodes, messages, and CSRF
            node when required.
        state:
          type: string
          description: >-
            Current flow state, such as choose_method, sent_email,
            passed_challenge, or success.
        request_url:
          type: string
          description: Original request URL used to create the flow.
        organization_id:
          type: string
          nullable: true
          description: organization id for organization-scoped flows, when supplied.
        created_at:
          type: string
          description: Flow creation timestamp.
          format: date-time
        updated_at:
          type: string
          description: Flow update timestamp.
          format: date-time
        refresh:
          type: boolean
          description: Whether the flow is a refresh flow.
        requested_aal:
          type: string
          description: Requested authenticator assurance level for the flow.
        identity:
          allOf:
            - 9cb587e8-c15a-435c-916a-4854d0ffa2c6
          description: Identity attached to settings flows when the system includes it.
      description: >-
        self-service flow object returned by login, registration, recovery, and
        settings create/update endpoints.

````