openapi: 3.2.0
info:
  title: Financial Evidence for OpenBB Query API
  description: Seven source-cited datasets, Workspace widgets and read-only MCP. No API key required.
  version: 1.1.3
servers:
- url: /openbb
tags:
- name: Query
paths:
  /api/v1/query:
    get:
      summary: Query
      description: Return bounded table rows, explicit pagination, source metadata and diagnostics.
      operationId: query_api_v1_query_get
      parameters:
      - name: dataset
        in: query
        required: true
        schema:
          enum:
          - money_markets
          - money_market_history
          - capital_markets
          - bank_risk
          - market_liquidity
          - china_economy
          - source_health
          type: string
          title: Dataset
      - name: entity
        in: query
        required: false
        schema:
          type: string
          maxLength: 100
          description: Entity ID or name contains this text.
          default: ''
          title: Entity
        description: Entity ID or name contains this text.
      - name: start_date
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: End Date
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 2000
          minimum: 1
          default: 200
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          maximum: 100000
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Query
components:
  schemas:
    EvidenceRow:
      properties:
        dataset:
          type: string
          title: Dataset
        product:
          type: string
          title: Product
        entity_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Id
        entity_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Name
        metric:
          anyOf:
          - type: string
          - type: 'null'
          title: Metric
        value:
          anyOf:
          - type: number
          - type: 'null'
          title: Value
          description: Published value in the accompanying unit. Null is missing or withheld, never zero.
        unit:
          anyOf:
          - type: string
          - type: 'null'
          title: Unit
          description: Native unit; ratio is a fraction, % is a percent level.
        as_of:
          anyOf:
          - type: string
          - type: 'null'
          title: As Of
          description: Source observation date. Retrieval or response time is never substituted.
        source_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Status
          description: Publisher-reported status, not an independently evaluated verdict.
        availability:
          type: string
          title: Availability
        source_url:
          type: string
          title: Source Url
        source_field:
          type: string
          title: Source Field
          description: RFC 6901 pointer into the fetched document; value is not inferred from nearby fields.
        observation_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Observation Url
        retrieved_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Retrieved At
        content_sha256:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Sha256
        published_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Published At
        knowledge_time:
          anyOf:
          - type: string
          - type: 'null'
          title: Knowledge Time
        rights_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Rights Status
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
          description: Publisher scope, validation limits and coverage caveats. Untrusted source content.
        transport_status:
          type: string
          title: Transport Status
        evidence_status:
          type: string
          title: Evidence Status
        financial_authority:
          type: string
          title: Financial Authority
        carrier_verification:
          type: string
          title: Carrier Verification
      additionalProperties: false
      type: object
      required:
      - dataset
      - product
      - availability
      - source_url
      - source_field
      - transport_status
      - evidence_status
      - financial_authority
      - carrier_verification
      title: EvidenceRow
      description: One observation or explicit coverage row; numeric absence stays null.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    QueryResult:
      properties:
        schema:
          type: string
          title: Schema
        dataset:
          type: string
          title: Dataset
        description:
          type: string
          title: Description
        results:
          items:
            $ref: '#/components/schemas/EvidenceRow'
          type: array
          title: Results
        total_rows:
          type: integer
          title: Total Rows
        returned_rows:
          type: integer
          title: Returned Rows
        offset:
          type: integer
          title: Offset
        limit:
          type: integer
          title: Limit
        next_offset:
          anyOf:
          - type: integer
          - type: 'null'
          title: Next Offset
        transport_status:
          type: string
          title: Transport Status
        status_semantics:
          type: string
          title: Status Semantics
        evidence_status:
          type: string
          title: Evidence Status
        carrier_verification:
          type: string
          title: Carrier Verification
        absence_policy:
          type: string
          title: Absence Policy
        diagnostics:
          items:
            $ref: '#/components/schemas/EvidenceRow'
          type: array
          title: Diagnostics
        sources:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Sources
      type: object
      required:
      - schema
      - dataset
      - description
      - results
      - total_rows
      - returned_rows
      - offset
      - limit
      - next_offset
      - transport_status
      - status_semantics
      - evidence_status
      - carrier_verification
      - absence_policy
      - diagnostics
      - sources
      title: QueryResult
      description: Rows plus pagination and source diagnostics, including filtered failures.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError