Xignite Earnings Calendar API

Company earnings announcement dates and earnings calendar data from the earningscalendar.xignite.com service.

OpenAPI Specification

xignite-xigniteearningscalendar-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteEarningsCalendar API
  version: 1.0.3
servers:
- url: https://earningscalendar.xignite.com
security:
- basic: []
tags:
- name: XigniteEarningsCalendar
paths:
  /xEarningsCalendar/ListExchanges:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Region
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            application/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/csv:
              schema:
                $ref: '#/components/schemas/ExchangeList'
  /xEarningsCalendar/ListSymbols:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Exchange
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SymbolList'
            text/json:
              schema:
                $ref: '#/components/schemas/SymbolList'
            application/xml:
              schema:
                $ref: '#/components/schemas/SymbolList'
            text/xml:
              schema:
                $ref: '#/components/schemas/SymbolList'
            text/csv:
              schema:
                $ref: '#/components/schemas/SymbolList'
  /xEarningsCalendar/ListEarningCalendarItems:
    get:
      tags:
      - XigniteEarningsCalendar
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundamentalTypesItems'
            text/json:
              schema:
                $ref: '#/components/schemas/FundamentalTypesItems'
            application/xml:
              schema:
                $ref: '#/components/schemas/FundamentalTypesItems'
            text/xml:
              schema:
                $ref: '#/components/schemas/FundamentalTypesItems'
            text/csv:
              schema:
                $ref: '#/components/schemas/FundamentalTypesItems'
  /xEarningsCalendar/GetEarningCalendarItem:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Type
        in: query
        schema:
          type: string
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningCalendarItem'
            text/json:
              schema:
                $ref: '#/components/schemas/EarningCalendarItem'
            application/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendarItem'
            text/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendarItem'
            text/csv:
              schema:
                $ref: '#/components/schemas/EarningCalendarItem'
  /xEarningsCalendar/GetEarningCalendarItems:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Types
        in: query
        schema:
          type: string
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityItemsSets'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityItemsSets'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityItemsSets'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityItemsSets'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityItemsSets'
  /xEarningsCalendar/GetEarningCall:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningCall'
            text/json:
              schema:
                $ref: '#/components/schemas/EarningCall'
            application/xml:
              schema:
                $ref: '#/components/schemas/EarningCall'
            text/xml:
              schema:
                $ref: '#/components/schemas/EarningCall'
            text/csv:
              schema:
                $ref: '#/components/schemas/EarningCall'
  /xEarningsCalendar/GetConferenceCallInformation:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceCallInformation'
            text/json:
              schema:
                $ref: '#/components/schemas/ConferenceCallInformation'
            application/xml:
              schema:
                $ref: '#/components/schemas/ConferenceCallInformation'
            text/xml:
              schema:
                $ref: '#/components/schemas/ConferenceCallInformation'
            text/csv:
              schema:
                $ref: '#/components/schemas/ConferenceCallInformation'
  /xEarningsCalendar/GetReplayInformation:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplayInformation'
            text/json:
              schema:
                $ref: '#/components/schemas/ReplayInformation'
            application/xml:
              schema:
                $ref: '#/components/schemas/ReplayInformation'
            text/xml:
              schema:
                $ref: '#/components/schemas/ReplayInformation'
            text/csv:
              schema:
                $ref: '#/components/schemas/ReplayInformation'
  /xEarningsCalendar/GetAnnouncement:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Announcement'
            text/json:
              schema:
                $ref: '#/components/schemas/Announcement'
            application/xml:
              schema:
                $ref: '#/components/schemas/Announcement'
            text/xml:
              schema:
                $ref: '#/components/schemas/Announcement'
            text/csv:
              schema:
                $ref: '#/components/schemas/Announcement'
  /xEarningsCalendar/GetEarningCalendarDay:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: MinimumMarketCap
        in: query
        schema:
          type: number
          format: double
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningCalendarDay'
            text/json:
              schema:
                $ref: '#/components/schemas/EarningCalendarDay'
            application/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendarDay'
            text/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendarDay'
            text/csv:
              schema:
                $ref: '#/components/schemas/EarningCalendarDay'
  /xEarningsCalendar/GetEarningCalendarRange:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      - name: MinimumMarketCap
        in: query
        schema:
          type: number
          format: double
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningCalendar'
            text/json:
              schema:
                $ref: '#/components/schemas/EarningCalendar'
            application/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendar'
            text/xml:
              schema:
                $ref: '#/components/schemas/EarningCalendar'
            text/csv:
              schema:
                $ref: '#/components/schemas/EarningCalendar'
  /xEarningsCalendar/GetEarningDates:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningDates'
            text/json:
              schema:
                $ref: '#/components/schemas/EarningDates'
            application/xml:
              schema:
                $ref: '#/components/schemas/EarningDates'
            text/xml:
              schema:
                $ref: '#/components/schemas/EarningDates'
            text/csv:
              schema:
                $ref: '#/components/schemas/EarningDates'
  /xEarningsCalendar/GetBoardMeeting:
    get:
      tags:
      - XigniteEarningsCalendar
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardMeeting'
            text/json:
              schema:
                $ref: '#/components/schemas/BoardMeeting'
            application/xml:
              schema:
                $ref: '#/components/schemas/BoardMeeting'
            text/xml:
              schema:
                $ref: '#/components/schemas/BoardMeeting'
            text/csv:
              schema:
                $ref: '#/components/schemas/BoardMeeting'
components:
  schemas:
    EarningCalendarDay:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    Common:
      type: object
      properties:
        Delay:
          type: number
          format: double
        Identity:
          type: string
          nullable: true
        Message:
          type: string
          nullable: true
        Outcome:
          allOf:
          - $ref: '#/components/schemas/OutcomeTypes'
      additionalProperties: false
    SymbolDescription:
      type: object
      properties:
        CompanyName:
          type: string
          nullable: true
        CompanyIdentifier:
          type: string
          nullable: true
        CompanyDomicile:
          type: string
          nullable: true
        CompanyRegion:
          type: string
          nullable: true
        SecurityName:
          type: string
          nullable: true
        Symbol:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        DividendStatus:
          type: string
          nullable: true
      additionalProperties: false
    FundamentalTypesItems:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    ExchangeDescription:
      type: object
      properties:
        Market:
          type: string
          nullable: true
        MarketIdentificationCode:
          type: string
          nullable: true
      additionalProperties: false
    EarningCalendar:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    ConferenceCallInformation:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      type: string
    EarningCall:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    EarningDates:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    Announcement:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    ReplayInformation:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    EarningCalendarItem:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    BoardMeeting:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
    ExchangeList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Region:
            type: string
            nullable: true
          ExchangeDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/ExchangeDescription'
            nullable: true
        additionalProperties: false
    SymbolList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Market:
            type: string
            nullable: true
          MarketIdentificationCode:
            type: string
            nullable: true
          SymbolDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/SymbolDescription'
            nullable: true
        additionalProperties: false
    SecurityItemsSets:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query