DataSinking Feedback API

openapi: 3.2.0
info:
  title: DataSinking Feedback API
  version: 1.0.0
  description: Full-text financial reports from the US (NYSE / NASDAQ / CBOE), China (SSE / SZSE / BSE), Japan (TSE), Korea (KOSPI / KOSDAQ / KONEX) and Taiwan (TWSE / TPEx) as clean Markdown. Query by FMP-style symbol (AAPL, 600519.SS, 7203.T, 005930.KS, 2330.TW) or filter by exchange, doc_type, report period, section. Sourced from each market's official disclosure platform (SEC EDGAR / cninfo / EDINET / DART / MOPS); every document carries a `source` field — please keep the attribution when redistributing. Authenticate with an `apikey` query parameter. Get a free key via POST /free-key.
servers:
- url: https://api.datasink.ing
security:
- ApiKeyQuery: []
tags:
- name: Feedback
paths:
  /feedback:
    post:
      operationId: submitFeedback
      summary: Request a full backfill of a stock's filings (idempotent — returns existing…
      description: 'Idempotent lookup-or-submit. If the stock was already submitted recently (within the last 127 feedback records for the key), it returns that existing status with queued=false; otherwise it queues a re-fetch from the IPO prospectus onward and returns queued=true. Feedback quota is separate from the document-reading quota. Free keys: once per 3 seconds, 31 stocks per 7 days per key (plus a shared pool of 8,191 per 7 days across all free users). Yearly keys: 3 per second, 8,191 stocks per 7 days per key. Runs in the background — poll GET /feedback/{id}.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                exchange:
                  type: string
                  description: Exchange code, e.g. szse.
                stock_code:
                  type: string
                  description: Stock code from list_stocks.
              required:
              - exchange
              - stock_code
      responses:
        '200':
          description: Feedback id + current status
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  status:
                    type: string
                    enum:
                    - pending
                    - processing
                    - done
                    - failed
                  queued:
                    type: boolean
                    description: true = this call just queued it; false = returned an existing record
                  exchange:
                    type: string
                  stock_code:
                    type: string
                  stock_name:
                    type:
                    - string
                    - 'null'
                  note:
                    type:
                    - string
                    - 'null'
                  created_at:
                    type: integer
                  completed_at:
                    type:
                    - integer
                    - 'null'
        '400':
          description: Invalid input (bad JSON / missing exchange or stock_code / stock not found)
        '429':
          description: Rate-limited or quota exceeded
      tags:
      - Feedback
  /feedback/{id}:
    get:
      operationId: getFeedbackStatus
      summary: Check the progress of a submitted feedback request
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Feedback status (pending / processing / done / failed)
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  status:
                    type: string
                    enum:
                    - pending
                    - processing
                    - done
                    - failed
                  exchange:
                    type: string
                  stock_code:
                    type: string
                  stock_name:
                    type:
                    - string
                    - 'null'
                  note:
                    type:
                    - string
                    - 'null'
                  created_at:
                    type: integer
                  completed_at:
                    type:
                    - integer
                    - 'null'
        '404':
          description: Feedback not found
      tags:
      - Feedback
components:
  securitySchemes:
    ApiKeyQuery:
      type: apiKey
      in: query
      name: apikey
      description: API key, passed as the `apikey` query parameter.