공시.ai Stream API

openapi: 3.2.0
info:
  title: 0si.ai Disclosure Stream API
  version: 1.5.0
  description: 'Analyzed Korean disclosures and US SEC filings, structured deltas, point-in-time fundamentals, filtered signed webhooks and replayable realtime SSE events. Pro keys use every endpoint at 120 requests per minute. Any signed-in account can create one trial key: REST reads only, 10 requests per minute and 100 per day (UTC), with the free plan''s 30-second publication delay; streams and webhooks return pro_plan_required. Developer events can be replayed for 30 days. Prepaid credits (where enabled): after the free daily allowance each successful call spends one credit, failed calls are never charged, and /status and /usage are always free. Responses report X-Credits-Charged, X-Credits-Remaining and X-Free-Requests-Remaining; with no credits left the API returns 402 insufficient_credits with a top_up_url for the account owner. Each key or MCP connection can carry a monthly credit budget set by its owner (MCP connections start at 2,000 credits); reaching it returns 402 key_budget_exceeded with a settings_url.'
  contact:
    name: 0si.ai developer support
    email: ops@0si.ai
    url: https://0si.ai/support
  termsOfService: https://0si.ai/terms
servers:
- url: https://app.0si.ai/api/v1
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Stream
paths:
  /stream:
    get:
      operationId: streamDisclosures
      summary: Stream disclosure events with Server-Sent Events
      parameters:
      - name: cursor
        in: query
        schema:
          type: integer
          minimum: 0
      - name: market
        in: query
        schema:
          type: string
          enum:
          - KR
          - US
        description: Omit for both markets.
      - name: filing_form
        in: query
        style: form
        explode: true
        schema:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/SecForm'
        description: US SEC only. Omit to receive every supported form.
      - name: stock_code
        in: query
        style: form
        explode: true
        schema:
          type: array
          maxItems: 100
          items:
            type: string
            maxLength: 15
        description: Repeat for up to 100 Korean stock codes or US tickers.
      - name: sentiment
        in: query
        style: form
        explode: true
        schema:
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/Sentiment'
        description: Repeat to match any of the listed sentiments. Non-material corrections count as neutral.
      - name: watchlist
        in: query
        schema:
          type: boolean
          default: false
        description: Only stocks saved in the key owner's 0si.ai watchlist.
      - name: Last-Event-ID
        in: header
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          description: Replayable SSE stream with immediate disclosure.created, disclosure.updated, and heartbeat events
          content:
            text/event-stream:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
      tags:
      - Stream
components:
  schemas:
    Error:
      type: object
      properties:
        detail:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            errors:
              type: array
              items:
                type: object
                additionalProperties: true
      description: ''
    Sentiment:
      type: string
      enum:
      - very_positive
      - positive
      - neutral
      - negative
      - very_negative
    SecForm:
      type: string
      pattern: ^[A-Z0-9][A-Z0-9 .-]{0,30}(/A)?$
      examples:
      - 8-K
      - 10-Q
      - 10-K
      - 20-F
      - 40-F
      - 6-K
  responses:
    RateLimited:
      description: Rate limit, trial daily quota (daily_quota_exceeded) or concurrent stream limit exceeded
      headers:
        Retry-After:
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: API key is missing, invalid, or revoked
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: osi_live_...
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key