FilingPulse Events API

openapi: 3.2.0
info:
  title: Filingpulse Io Events API
  version: 0.1.0
  contact:
    name: FilingPulse
    url: https://filingpulse.io/
    email: raxcuh06@gmail.com
  description: 'Operations tagged events across 2 of this provider''s published API definitions: api.filingpulse.io-openapi.json, filingpulse-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.filingpulse.io
  description: Production
tags:
- name: Events
  description: 8-K corporate events classified by official item code.
paths:
  /v1/events:
    get:
      tags:
      - Events
      summary: List 8-K corporate events
      operationId: events_v1_events_get
      security:
      - ApiKeyAuth: []
      parameters:
      - name: item
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^\d\.\d{2}$
          - type: 'null'
          description: 8-K item code, e.g. 2.02
          title: Item
        description: 8-K item code, e.g. 2.02
      - name: ticker
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          description: Issuer ticker symbol, resolved to a CIK via this dataset's Form 4 filings (8-K headers carry no ticker); 404 if no Form 4 has carried it
          title: Ticker
        description: Issuer ticker symbol, resolved to a CIK via this dataset's Form 4 filings (8-K headers carry no ticker); 404 if no Form 4 has carried it
      - name: cik
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^\d{1,10}$
          - type: 'null'
          description: Issuer CIK, digits only
          title: Cik
        description: Issuer CIK, digits only
      - name: since
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          - type: 'null'
          description: Only events filed on/after this date
          title: Since
        description: Only events filed on/after this date
      - name: until
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          - type: 'null'
          description: Only events filed on/before this date
          title: Until
        description: Only events filed on/before this date
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Rows per page (max 200)
          default: 50
          title: Limit
        description: Rows per page (max 200)
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 0
          description: Pagination offset (max 10,000)
          default: 0
          title: Offset
        description: Pagination offset (max 10,000)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Missing or invalid X-API-Key.
        '429':
          description: Per-minute rate limit or monthly quota exceeded. Per-minute 429s carry Retry-After; quota 429s carry X-Quota-Limit / X-Quota-Used. Quotas reset at 00:00 UTC on the 1st.
        '404':
          description: No resource with that identifier (or not owned by this key).
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.filingpulse.io
      description: Production
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API key, e.g. fp_xxxxx. All /v1 endpoints except /v1/health and /v1/schema require one.
      in: header
      name: X-API-Key
x-refined-from:
- api.filingpulse.io-openapi.json
- filingpulse-io-openapi.json
x-provenance:
  method: harvested
  publisher: FilingPulse
  source: https://api.filingpulse.io/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)