tickfeed-pro System API

openapi: 3.2.0
info:
  title: Tickfeed Pro System API
  version: 0.1.0
  description: 'Operations tagged system across 2 of this provider''s published API definitions: api.tickfeed.pro-openapi.json, tickfeed-pro-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: System
paths:
  /health:
    get:
      tags:
      - System
      summary: Health
      description: 'Service health, reported separately from the HTTP server itself.


        * `down` (HTTP 503): the upstream feed is unreachable.

        * `degraded`: a feed is stale during trading hours or the pipeline needs attention.

        * `ok`: everything else, including feeds that are quiet because their market is closed.


        External callers see the public form (status and per-symbol freshness); the detailed form

        is only returned to local operator requests.'
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthResponse'
        '503':
          description: Market data feed down
  /status:
    get:
      tags:
      - System
      summary: Status
      description: 'Public service status: overall state and per-symbol data freshness (cached for 2 s).


        Browsers (Accept: text/html) get the status page; everything else gets JSON.'
      operationId: status_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthResponse'
  /status.json:
    get:
      tags:
      - System
      summary: Status Json
      description: Same as `/status`, always JSON.
      operationId: status_json_status_json_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthResponse'
components:
  schemas:
    PublicHealthResponse:
      properties:
        status:
          type: string
          enum:
          - ok
          - degraded
          - down
          title: Status
        feeds:
          items:
            $ref: '#/components/schemas/PublicFeed'
          type: array
          title: Feeds
        checked_at:
          type: string
          format: date-time
          title: Checked At
      type: object
      required:
      - status
      - feeds
      - checked_at
      title: PublicHealthResponse
      description: 'Health as shown to external callers: service state and data freshness, no internals.'
    PublicFeed:
      properties:
        symbol:
          type: string
          title: Symbol
        market_open:
          type: boolean
          title: Market Open
        status:
          type: string
          enum:
          - fresh
          - market_closed
          - stale
          - unavailable
          title: Status
          description: 'fresh: last tick no older than stale_after_seconds. market_closed: older, but the market is outside its scheduled session (or within the grace period right after it opened). stale: older while the market is scheduled to be trading, which indicates a feed problem.'
        last_tick_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Tick Time
        age_seconds:
          anyOf:
          - type: number
          - type: 'null'
          title: Age Seconds
      type: object
      required:
      - symbol
      - market_open
      - status
      - last_tick_time
      - age_seconds
      title: PublicFeed
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Your API key
      in: header
      name: X-API-Key
x-refined-from:
- api.tickfeed.pro-openapi.json
- tickfeed-pro-openapi.json