Nordic Financial News Event Types API

openapi: 3.2.0
info:
  title: Nordic Financial News Event Types API
  version: v1.0
  contact:
    name: API Support
    email: hello@nordicfinancialnews.com
  description: 'Operations tagged Event Types across 2 of this provider''s published API definitions: nordic-financial-news-openapi-original.yml, nordic-financial-news-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://nordicfinancialnews.com
  description: Production server
tags:
- name: Event Types
paths:
  /api/v1/event_types:
    get:
      summary: List Event Types
      tags:
      - Event Types
      security:
      - bearer_auth: []
      description: Returns all active event types, grouped by category (in the categories' defined order) and ordered by slug within each. Event type slugs are the values for the `event_type` filter on `GET /api/v1/events`.
      parameters:
      - name: fields
        in: query
        required: false
        description: 'Comma-separated list of fields to include. Available fields: `id`, `slug`, `label`, `category`, `summary`. `id` is always included.'
        example: id,slug,label
        schema:
          type: string
      responses:
        '200':
          description: Event types retrieved successfully
          content:
            application/json:
              examples:
                basic_response:
                  value:
                    event_types:
                    - id: evt_earnrep01
                      slug: earnings-report
                      label: Earnings Report
                      category: earnings
                      summary: A company's scheduled quarterly, interim or annual results without consensus framing.
                    pagination:
                      count: 1
                      next_cursor: null
              schema:
                type: object
                properties:
                  event_types:
                    type: array
                    items:
                      $ref: '#/components/schemas/EventTypeSummary'
                  pagination:
                    type: object
                    properties:
                      count:
                        type: integer
                      next_cursor:
                        type:
                        - string
                        - 'null'
                required:
                - event_types
        '401':
          description: unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    type: https://docs.nordicfinancialnews.com/problems/auth-invalid
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid API key
                    instance: urn:request:abc123
              schema:
                $ref: '#/components/schemas/problem_details'
        '403':
          description: forbidden - missing scope
          content:
            application/json:
              examples:
                forbidden:
                  value:
                    type: https://docs.nordicfinancialnews.com/problems/auth-insufficient
                    title: Forbidden
                    status: 403
                    detail: Insufficient scope for this resource
                    instance: urn:request:abc123
              schema:
                $ref: '#/components/schemas/problem_details'
      operationId: getApiV1EventTypes
      x-operation-id-source: derived
    servers:
    - url: https://nordicfinancialnews.com
      description: Production server
components:
  schemas:
    EventTypeSummary:
      type: object
      required:
      - id
      - slug
      - label
      - category
      - summary
      properties:
        id:
          type: string
          description: Unique event type identifier
          example: evt_earnrep01
        slug:
          type: string
          description: 'Event type slug: the value for the `event_type` filter on `GET /api/v1/events` only. `GET /api/v1/calendar_events` takes a different, underscored vocabulary enumerated on that endpoint; these slugs are not accepted there, and a few spellings overlap while denoting different things.'
          example: earnings-report
        label:
          type: string
          description: Event type display label
          example: Earnings Report
        category:
          type: string
          description: The broader category this type belongs to
          enum:
          - earnings
          - ma
          - executive_changes
          - regulatory
          - dividends
          - equity_actions
          - legal
          - credit
          - bankruptcy
          - partnerships
          - products
          - restructuring
          - macro
          - funding
          - esg
          - operations
          - analyst_ratings
          - shareholder_activity
          - other
          - commentary
          example: earnings
        summary:
          type:
          - string
          - 'null'
          description: One-line description of what this type covers
          example: A company's scheduled quarterly, interim or annual results without consensus framing.
    problem_details:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          type: string
          description: URI that identifies the problem type
        title:
          type: string
          description: Short human-readable summary
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable explanation
        instance:
          type: string
          description: URI that identifies the specific occurrence
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API Key authentication using Bearer token
x-refined-from:
- nordic-financial-news-openapi-original.yml
- nordic-financial-news-openapi.yml