FilingSift Reference API

openapi: 3.2.0
info:
  title: FilingSift Reference API
  version: 1.0.0
  description: FilingSift v1 REST contract for source-cited SEC filing facts, facilities, covenants, filing comparisons, research workflows, and reference-source intelligence. Responses preserve source evidence, provenance, uncertainty, and validation status so every result can be traced to its origin. Route availability follows the production service and the authenticated account's permissions; current endpoint responses are authoritative. FilingSift does not automatically assign materiality, investment, financial, or legal conclusions. Request limits, authentication, issuer/history access, and pagination differ by resource. The URL query guard does not count JSON body fields. Query cost equals 5 plus the effective query-string limit (20 when omitted), plus 3 for each query parameter other than limit and cursor, plus 2 when a cursor is present. X-Query-Cost and X-Max-Query-Cost report the applied and allowed amounts when the request reaches the query guard; earlier refusals may omit them. Plan limits stop requests or account actions; they do not create overage charges. The SEC worker restarts one minute after its prior bounded run completes, plus randomized delay, with an operating target of discovery within five minutes of SEC acceptance. Extraction and delivery follow asynchronously. Active reference sources fetch on the first eligible cache miss with source-specific caches from five minutes to six hours. Treasury, Federal Reserve Board, OFR, BIS, the FDIC and GLEIF expansion datasets, and the Treasury Fiscal combined report have no deployed saved monitor. Alert mode instant makes a processed alert due for the next ingestion monitoring stage; quiet hours, capacity, and retries can defer delivery. Operating targets are not current-state claims; GET /coverage/status is authoritative for current SEC backlog and delay.
  contact:
    name: FilingSift Support
    email: support@filingsift.com
servers:
- url: https://api.filingsift.com/api/v1
  description: FilingSift production API
- url: http://127.0.0.1:5000/api/v1
  description: Local development
tags:
- name: Reference
  description: Free public
  source-attributed and operationally bounded reference datasets: null
paths:
  /reference/bis/credit:
    get:
      tags:
      - Reference
      operationId: getBisCreditContext
      summary: Retrieve the compatible public BIS credit and debt-service context
      description: Free and unmetered. r93 retains this original two-series, one-country route for compatibility; use /reference/bis/compare for the deployed six-dataflow, 24-reference-area contract and one-to-four-country comparisons. One to 20 completed quarters and abuse limits apply.
      security: []
      parameters:
      - name: country
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 2
      - name: startQuarter
        in: query
        required: true
        schema:
          type: string
          pattern: ^(19|20)[0-9]{2}-Q[1-4]$
      - name: endQuarter
        in: query
        required: true
        schema:
          type: string
          pattern: ^(19|20)[0-9]{2}-Q[1-4]$
      responses:
        '200':
          description: Free public BIS credit-to-GDP and debt-service response with source receipts
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /reference/bis/compare:
    get:
      tags:
      - Reference
      operationId: compareBisCountryContext
      summary: Compare one exact BIS dataset and sector across one to four countries
      description: Free and unmetered. Responses retain missing/confidential states, source receipts, and a dataset-specific comparability warning; country ranking is prohibited.
      security: []
      parameters:
      - name: dataset
        in: query
        required: true
        schema:
          type: string
          enum:
          - total_credit
          - debt_service
          - credit_gap
          - property_price
          - debt_securities
          - foreign_exchange
      - name: sector
        in: query
        required: true
        description: Must be compatible with the selected dataset.
        schema:
          type: string
          enum:
          - P
          - N
          - H
          - G
          - ALL
          - S1
          - S11
          - S12
          - S13
      - name: countries
        in: query
        required: true
        description: One to four distinct comma-separated supported reference-area codes.
        schema:
          type: string
          pattern: ^[A-Z0-9]{2}(,[A-Z0-9]{2}){0,3}$
      - name: startQuarter
        in: query
        required: true
        schema:
          type: string
          pattern: ^(19|20)[0-9]{2}-Q[1-4]$
      - name: endQuarter
        in: query
        required: true
        schema:
          type: string
          pattern: ^(19|20)[0-9]{2}-Q[1-4]$
      responses:
        '200':
          description: One exact series definition per selected country with warnings
          status flags: null
          attribution and SHA-256 source receipts: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - reason
          properties:
            code:
              type: string
            message:
              type: string
            reason:
              $ref: '#/components/schemas/ErrorReason'
        requestId:
          type: string
        meta:
          $ref: '#/components/schemas/ApiMeta'
    ErrorReason:
      type: object
      required:
      - category
      - retryable
      properties:
        category:
          type: string
          enum:
          - request
          - rate_limit
          - response_limit
          - service
        retryable:
          type: boolean
        retryAfterSeconds:
          type: integer
        details:
          type:
          - object
          - 'null'
          additionalProperties: true
        maximumCost:
          type: integer
        calculatedCost:
          type: integer
        maximumBytes:
          type: integer
        actualBytes:
          type: integer
    ApiMeta:
      type: object
      required:
      - schemaVersion
      - apiVersion
      properties:
        schemaVersion:
          type: string
          const: 1.0.0
        apiVersion:
          type: string
          const: '1'
        mode:
          type: string
        pagination:
          $ref: '#/components/schemas/Pagination'
    Pagination:
      type: object
      required:
      - limit
      - returned
      - hasMore
      - nextCursor
      properties:
        limit:
          type: integer
          minimum: 1
          maximum: 100
        returned:
          type: integer
          minimum: 0
          maximum: 100
        hasMore:
          type: boolean
        nextCursor:
          type:
          - string
          - 'null'
  responses:
    RateLimited:
      description: API-wide fixed-window request limit exceeded
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: Turnstile, commercial billing, or another required service is temporarily or intentionally unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid filter, cursor, request, or query cost
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    RateLimitReset:
      description: Seconds until the current fixed window resets
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests remaining in the current window
      schema:
        type: integer
    RetryAfter:
      description: Seconds before retrying
      schema:
        type: integer
    RateLimitLimit:
      description: Request limit for the current fixed window
      schema:
        type: integer
  securitySchemes:
    BrowserSession:
      type: apiKey
      in: cookie
      name: __Host-filingsift_session
      description: Secure HttpOnly SameSite=Lax production browser cookie, set by authentication responses. Raw tokens are not returned to browser JavaScript. Cookie-authenticated mutations require a trusted Origin and X-FilingSift-CSRF header equal to 1. API keys do not authenticate browser-only workspace operations.
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: FilingSift API key
      description: High-entropy fs_live API key in Authorization. FilingSift persists only token hashes. Production browser sessions use BrowserSession cookies, not Bearer tokens.