Dow Jones Calendar Events API

openapi: 3.2.0
info:
  title: Calendar Live Calendar Events API
  description: Calendar Live API
  version: 1.1.9
servers:
- url: https://api.dowjones.com/
tags:
- name: Calendar Events
paths:
  /calendar-events/{id}:
    get:
      tags:
      - Calendar Events
      summary: Searches for a single event by its unique identifier.
      parameters:
      - name: id
        in: path
        description: Number that uniquely identifies the event.
        required: true
        schema:
          type: integer
      - name: filter[event_language]
        in: query
        description: Translate descriptions to this language if translation is available, otherwise show English version
        schema:
          type: string
      - name: options[show_ecoinfo]
        in: query
        description: Include ecoinfo as part of the event result.
        schema:
          type: boolean
          enum:
          - true
          - false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
  /calendar-events/search:
    get:
      tags:
      - Calendar Events
      summary: Searches for specific events based on the given filter.
      parameters:
      - name: filter[has_key_events_only]
        in: query
        description: Include only macroeconomic events that Dow Jones editors have classified as having a market impact. This categorization is based on news judgement and is updated on news merit.
        schema:
          type: boolean
          enum:
          - true
          - false
      - name: filter[has_confirmed_events_only]
        in: query
        description: Include only events whose date and time have been confirmed.
        schema:
          type: boolean
          enum:
          - true
          - false
      - name: filter[time_specified]
        in: query
        description: Filter events based on time specified
        schema:
          type: boolean
          enum:
          - true
          - false
      - name: filter[country]
        in: query
        description: ORed list of countries associated with the event (e.g. BH-Bahrain, AZ-Azerbaijan). These are countries related to the entity that provides data or sponsorship for the event. Use ISO codes and separate them with new lines when providing multiple codes.
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 2
            type: string
      - name: filter[region]
        in: query
        description: ORed list of regions associated with the event (e.g. EMEM, EU, G10). These are regions related to the entity that provides data or sponsorship for the event. Use new lines when providing multiple region codes.
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 2
            type: string
      - name: filter[event_code]
        in: query
        description: 'Event type: ICC-Corporate events, IEP-Economic and Political events, IDC-Treasury Auctions.'
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 0
            type: string
            enum:
            - ICC
            - IEP
            - IDC
      - name: filter[series_code]
        in: query
        description: ORed list of event series codes (e.g. TrdBal-Trade Balance, ImptPx-Import Prices). Series codes enable searching for historical and upcoming repeatable events. Use new lines when providing multiple series codes.
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 2
            type: string
      - name: filter[event_class]
        in: query
        description: Single classification of the event (e.g. IEP_STAT-Statistics and Economic Indicators, ICC_ANL-Earnings/Analysts Calls and GMs).
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 0
            type: string
            enum:
            - ICC_ANAL
            - ICC_ANL
            - ICC_BRO
            - ICC_DIV
            - ICC_EARN
            - ICC_EXC
            - ICC_IND
            - ICC_IPO
            - ICC_OTH
            - ICC_SPLT
            - IEP_CAN
            - IEP_CONF
            - IEP_DEBT
            - IEP_EVT
            - IEP_HOL
            - IEP_IND
            - IEP_POL
            - IEP_STAT
            - IEP_US
            - IDC_ACT
            - IDC_ISS
      - name: filter[start_date]
        in: query
        description: Earliest date and time of interest, yyyy-MM-dd'T'HH:mm:ss'Z'.
        schema:
          type: string
          format: date-time
      - name: filter[end_date]
        in: query
        description: Latest date and time of interest, yyyy-MM-dd'T'HH:mm:ss'Z'.
        schema:
          type: string
          format: date-time
      - name: filter[ticker]
        in: query
        description: ORed list of Newswires codes. Use new lines when providing multiple ticker codes.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter[isin]
        in: query
        description: ORed list of ISINs. Use new lines when providing multiple isin codes.
        style: form
        explode: true
        schema:
          type: array
          items:
            minLength: 2
            type: string
      - name: filter[event_language]
        in: query
        description: Translate descriptions to this language if translation is available; otherwise, show English version.
        style: form
        explode: true
        schema:
          maxItems: 1
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            enum:
            - ''
            - zh
            - ar
            - it
            - de
            - jp
      - name: options[show_ecoinfo]
        in: query
        description: Include ecoinfo as part of the events results.
        schema:
          type: boolean
          enum:
          - true
          - false
      - name: page[limit]
        in: query
        description: Maximum number of results for a single request, max size 1000.
        schema:
          type: integer
      - name: page[offset]
        in: query
        description: Paging offset, the event ID given serves as a reference point to request additional events (beyond what was returned according to the limit value). The response does not include the reference ID. To page backward to get older events, make the event number negative.
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
    post:
      tags:
      - Calendar Events
      summary: Searches for specific events based on the given filters.
      requestBody:
        description: Criteria
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postParams'
        required: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
      x-codegen-request-body-name: Criteria
  /calendar-events/:
    get:
      tags:
      - Calendar Events
      summary: Searches for requested events with options for updated events.
      parameters:
      - name: filter[id]
        in: query
        description: ORed list of event IDs. Separate each event ID with a comma when providing multiple events.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filter[last_updated_time]
        in: query
        description: Search only for events that have been updated since this date and time, (yyyy-MM-dd'T'HH:mm:ss'Z').
        schema:
          type: string
          format: date-time
      - name: filter[has_updates]
        in: query
        description: Search only for events that have been updated.
        schema:
          type: boolean
      - name: filter[event_language]
        in: query
        description: Translate descriptions to this language if translation is available; otherwise, show English version.
        schema:
          type: string
      - name: options[show_ecoinfo]
        in: query
        description: Include ecoinfo as part of the events results.
        schema:
          type: boolean
          enum:
          - true
          - false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
    post:
      tags:
      - Calendar Events
      summary: Searches for requested events with options for updated events.
      requestBody:
        description: Criteria
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eventsPostParams'
        required: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
      x-codegen-request-body-name: Criteria
  /calendar-events:
    get:
      tags:
      - Calendar Events
      summary: Searches for requested events with options for updated events.
      parameters:
      - name: filter[id]
        in: query
        description: ORed list of event IDs. Separate each event ID with a comma when providing multiple events.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filter[last_updated_time]
        in: query
        description: Search only for events that have been updated since this date and time, (yyyy-MM-dd'T'HH:mm:ss'Z').
        schema:
          type: string
          format: date-time
      - name: filter[has_updates]
        in: query
        description: Search only for events that have been updated.
        schema:
          type: boolean
      - name: filter[event_language]
        in: query
        description: Translate descriptions to this language if translation is available; otherwise, show English version.
        schema:
          type: string
      - name: options[show_ecoinfo]
        in: query
        description: Include ecoinfo as part of the events results.
        schema:
          type: boolean
          enum:
          - true
          - false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
    post:
      tags:
      - Calendar Events
      summary: Searches for requested events with options for updated events
      requestBody:
        description: Criteria
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eventsPostParams'
        required: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsModel'
        '400':
          description: 'Bad Request: Incorrect Parameters.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Unauthorized Access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: 'Not Found: No resource found for the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: 'Internal Server Error: Server encountered an unexpected condition.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '503':
          description: 'Service Unavailable: Server is currently unable to handle the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - bearerAuth: []
      x-codegen-request-body-name: Criteria
components:
  schemas:
    eventDetailModel:
      type: object
      properties:
        id:
          type: string
          description: Index count of the report.
        description:
          type: string
          description: Describes the individual data element reported.
        dj_combo_detail:
          type: string
          description: Optional. Concise combination of the name of an economic indicator event and a data element name. This combination is useful for single-line calendar display rather than nested elements below their event name.
        importance:
          type: string
          description: 'Optional. Applied to Economic events by the Dow Jones news team. It represents their assessment of the marketplace importance of the specified data element. Valid values: High (H), Medium (M), and Low (L).'
        expected:
          $ref: '#/components/schemas/detailDataValueModel'
        previous:
          $ref: '#/components/schemas/detailDataValueModel'
        actual:
          $ref: '#/components/schemas/detailDataValueModel'
        prior_revised:
          $ref: '#/components/schemas/detailDataValueModel'
        delta:
          $ref: '#/components/schemas/detailDataValueModel'
    postParams:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Servive name
              example: CalendarEvents
            type:
              type: string
              description: Call name
              example: Search
            attributes:
              type: object
              properties:
                filter:
                  $ref: '#/components/schemas/searchCriteria'
                options:
                  $ref: '#/components/schemas/options'
                page:
                  $ref: '#/components/schemas/pagingCriteria'
    eventDataModel:
      type: object
      properties:
        type:
          type: string
        id:
          type: integer
          description: Number that uniquely identifies an event.
        attributes:
          type: object
          properties:
            is_confirmed:
              type: boolean
              description: Whether the event has been confirmed for this date and time
            is_key_event:
              type: boolean
              description: Whether a macroeconomic event has been identified by the Dow Jones News team as having a market impact, based on news judgement and updated on news merit.
            is_updating:
              type: boolean
              description: For events that release actual data, whether the data will be updated with new figures. This Updating flag is different from the Elementized flag. The Updating flag is set for all the Elementized events and for any additional events that are manually or otherwise updated with actual figures by Dow Jones.
            last_modified:
              type: string
              description: Date and time when the last update occurred.
            date_local:
              type: string
              description: Date and time when the event actually takes place in its location, including adjustments for daylight savings time.
            date_gmt:
              type: string
              description: The event's date and time in GMT, not considering daylight savings time.
            time_specified:
              type: boolean
            scheduled_time:
              type: string
              description: 'Optional. Either a period in which the event is likely to occur or an indication that the time is unknown. The period is relative to the event''s local time. Valid values: BMO-Before Market Opening, DMT-During Market Time, AMC-After Market Close, NA-Not Applicable. Specified only when the event''s time is not confirmed.'
            company_url:
              type: string
              description: 'Optional. URL of the company related to the event. Note: It is Null for economic events.'
            venue:
              type: string
              description: Optional. Location where the event takes place.
            country:
              type: object
              properties:
                dj_country:
                  type: string
                  description: Dow Jones Newswires country code that can be used to search and filter Dow Jones news.
                iso_country:
                  type: string
                  description: ISO country code.
                titan_country:
                  type: string
                  description: Calendar Live titan country code is the one primarily used. It is the reference country code for Dow Jones Calendar Live feed implementation via Dow Jones Newswires low latency platform.
              description: Country related to the entity that provides data or sponsorship for the event.
            regions:
              type: array
              description: Regions related to the entity that provides data or sponsorship for the event.
              items:
                type: string
            tickers:
              type: array
              description: 'Optional. Company ticker symbols. Note: Can also store general Newswires codes.'
              items:
                type: string
            isin:
              type: string
              description: Optional. Company's International Securities Identification Number (ISIN). For Treasury Auctions, it may store a Committee on Uniform Securities Identification Procedures (CUSIP) code.
            news_code:
              type: string
              description: Optional. Newswires code that can be used to link real time news from Dow Jones Newswires.
            organization_name:
              type: string
              description: Optional. Name of the entity holding the event.
            period:
              type: string
              description: Optional. Time frame covered by the data.
            description:
              type: string
              description: Defines the event.
            long_description:
              type: string
              description: Detailed definition of the event.
            dj_event_name:
              type: string
              description: Dow Jones Newswires formal name of the event. Dow Jones recommends displaying this name when available instead of the description because this name is a concise version of it.
            event_url:
              type: string
              description: Optional. URL where the source provides additional event-related information.
            event_code:
              type: string
              description: 'Event''s type code. Valid values: ICC-Corporate events, IEP-Economic and Political events, IDC-Treasury Auctions.'
            index_codes:
              type: array
              description: Optional. Dow Jones Newswires compliant news codes for related tracking indexes, such as Dow Jones Industrial Average.
              items:
                type: string
            series_code:
              type: string
              description: Optional. Defines repeatable events. For Economic events, the combination of a series code and a country code uniquely identifies a repeatable event for which Dow Jones provides numeric data.
            event_class:
              type: string
              description: Optional. Provides further details about the event type, which category the event belongs to.
            geo_location:
              type: object
              properties:
                latitude:
                  type: string
                longitude:
                  type: string
              description: Optional. Longitude and latitude where event occurs.
            social_media:
              type: array
              description: Optional. Social media URLs that provide event-related information.
              items:
                type: object
                properties:
                  type:
                    type: string
                  description:
                    type: string
                  scope:
                    type: string
                  link:
                    type: string
            influencers:
              type: array
              description: Optional. Names of persons of economic importance who may be associated with the event. Frequently, it is empty.
              items:
                type: object
                properties:
                  code:
                    type: string
                  name:
                    type: string
            details:
              type: array
              description: Optional. Additional information about the event.
              items:
                $ref: '#/components/schemas/eventDetailModel'
            ecoinfo:
              $ref: '#/components/schemas/ecoinfo'
            generic_query:
              type: string
            dj_query:
              type: string
        links:
          type: object
          properties:
            self:
              type: string
    ecoinfo:
      type: object
      properties:
        frequency:
          type: string
        meaning:
          type: string
        definition:
          type: string
    detailDataValueModel:
      type: object
      properties:
        value:
          type: string
          description: Value reported
        last_modified_date_time:
          type: string
          description: Date and time when the value was provided.
        unit:
          type: string
          description: 'Optional. Multiplier for the units of the reported value. If the unit attribute is not present, the data value has a scale of one. Valid values: K–Thousands, M–Millions, B–Billions, T–Trillions.'
        is_pct:
          type: boolean
          description: Optional. Whether the reported value is a percentage. This information is useful to appropriately format the value displayed.
        is_chg:
          type: boolean
          description: 'Optional. Whether the reported value represents a net change. This information is useful to appropriately format the net change displayed. Unlike regular positive values, users may wish to prepend a “+” sign to positive net changes. Valid values indicate: true–The value represents a net change and is not simply a positive value. false–The value simply represents a positive value and is not a net change.'
        currency:
          type: string
          description: Optional. Where applicable, monetary unit of the reported value. Valid currency codes can be found using the taxonomy currency endpoint.
        source:
          type: string
          description: 'Optional. Source of information. Valid values: Factset, Kantar, and Null (stands for Dow Jones).'
    searchCriteria:
      type: object
      properties:
        has_confirmed_events_only:
          type: boolean
          description: Include only events whose date and time have been confirmed.
          example: false
        has_key_events_only:
          type: boolean
          description: Include only events marked as key events. A key event is a macroeconomic event that has been identified by the Dow Jones News team as having a market impact.
          example: false
        time_specified:
          type: boolean
          description: Filter events based on time specified
          example: false
        country:
          type: array
          description: ORed list of countries associated with the event (ISO Code). These are countries related to the entity that provides data or sponsorship for the event.
          items:
            type: string
        region:
          type: array
          description: ORed list of regions associated with the event (e.g. Asia). These are regions related to the entity that provides data or sponsorship for the event.
          items:
            type: string
        event_code:
          type: array
          description: 'Event type: ICC-Corporate, IEP-Economic and Political, IDC-Treasury Auctions.'
          items:
            type: string
            enum:
            - ICC
            - IEP
            - IDC
        series_code:
          type: array
          description: ORed list of event series codes (e.g. TrdBal-Trade Balance, ImptPx-Import Prices).
          items:
            minLength: 2
            type: string
        event_class:
          type: array
          description: Event classification (e.g. IEP_STAT for Statistics and Economic Indicators, ICC_ANL Earnings/Analysts Calls and GMs).
          items:
            type: string
            enum:
            - ICC_ANAL
            - ICC_ANL
            - ICC_BRO
            - ICC_DIV
            - ICC_EARN
            - ICC_EXC
            - ICC_IND
            - ICC_IPO
            - ICC_OTH
            - ICC_SPLT
            - IEP_CAN
            - IEP_CONF
            - IEP_DEBT
            - IEP_EVT
            - IEP_HOL
            - IEP_IND
            - IEP_POL
            - IEP_STAT
            - IEP_US
            - IDC_ACT
            - IDC_ISS
        start_date:
          type: string
          description: Earliest date and time of interest (yyyy-MM-dd'T'HH:mm:ss'Z').
          format: date-time
          example: '2017-01-01T00:00:00.000Z'
        end_date:
          type: string
          description: Latest date and time o

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-calendar-events-api-openapi.yml