Xignite Global News API

Company financial news headlines, market summaries, and press release data from the globalnews.xignite.com service.

OpenAPI Specification

xignite-xigniteglobalnews-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteGlobalNews API
  version: 1.0.3
servers:
- url: https://globalnews.xignite.com
security:
- basic: []
tags:
- name: XigniteGlobalNews
paths:
  /xGlobalNews/GetTodaysMarketHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetTodaysMarketReleases:
    get:
      tags:
      - XigniteGlobalNews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetTodaysMarketHeadlinesBySector:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Sector
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetTodaysSecurityHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      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/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetMarketHeadlinesByQuery:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Date
        in: query
        schema:
          type: string
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      - name: QueryText
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetTopMarketHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetTopMarketHeadlinesBySector:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      - name: Sector
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetRecentTopSecurityHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetTopSecurityHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetHistoricalSecurityHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetHistoricalMarketHeadlines:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetHistoricalMarketReleases:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetHistoricalMarketHeadlinesBySector:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      - name: Sector
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlines'
  /xGlobalNews/GetMarketNewsDetails:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Reference
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketNewsItem'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketNewsItem'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketNewsItem'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketNewsItem'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketNewsItem'
  /xGlobalNews/GetTodaysReleasesBySecurity:
    get:
      tags:
      - XigniteGlobalNews
      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/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetTopReleasesBySecurity:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/GetHistoricalReleasesBySecurity:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlines'
  /xGlobalNews/ListSectors:
    get:
      tags:
      - XigniteGlobalNews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/json:
              schema:
                $ref: '#/components/schemas/SectorList'
            application/xml:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/xml:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/csv:
              schema:
                $ref: '#/components/schemas/SectorList'
  /xGlobalNews/GetTopSecuritySummaries:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
  /xGlobalNews/GetTopReleaseSummariesBySecurity:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/json:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            application/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/xml:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
            text/csv:
              schema:
                $ref: '#/components/schemas/SecurityHeadlineSummaries'
  /xGlobalNews/GetTopMarketSummaries:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlineSummaries'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketHeadlineSummaries'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlineSummaries'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketHeadlineSummaries'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketHeadlineSummaries'
  /xGlobalNews/ListExchanges:
    get:
      tags:
      - XigniteGlobalNews
      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'
  /xGlobalNews/ListSymbols:
    get:
      tags:
      - XigniteGlobalNews
      parameters:
      - name: Exchange
        in: query
        schema:
          type: string
      - name: StartSymbol
        in: query
        schema:
          type: string
      - name: EndSymbol
        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'
components:
  schemas:
    SectorList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Sectors:
            type: array
            items:
              type: string
            nullable: true
        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
    Security:
      type: object
      properties:
        CIK:
          type: string
          nullable: true
        CUSIP:
          type: string
          nullable: true
        Symbol:
          type: string
          nullable: true
        ISIN:
          type: string
          nullable: true
        Valoren:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        Market:
          type: string
          nullable: true
        MarketIdentificationCode:
          type: string
          nullable: true
        MostLiquidExchange:
          type: boolean
        CategoryOrIndustry:
          type: string
          nullable: true
      additionalProperties: false
    ExchangeDescription:
      type: object
      properties:
        MarketIdentificationCode:
          type: string
          nullable: true
        Market:
          type: string
          nullable: true
      additionalProperties: false
    MarketHeadlineSummaries:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          HeadlineSummaries:
            type: array
            items:
              $ref: '#/components/schemas/MarketHeadlineSummary'
            nullable: true
        additionalProperties: false
    SymbolList:
      type: object
      properties:
        Exchange:
          allOf:
          - $ref: '#/components/schemas/ExchangeDescription'
          nullable: true
        SecurityDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/SecurityDescription'
          nullable: true
      additionalProperties: false
    SecurityHeadlineSummary:
      allOf:
      - $ref: '#/components/schemas/SecurityHeadline'
      - type: object
        properties:
          Summary:
            type: string
            nullable: true
          PaywallType:
            type: string
            nullable: true
        additionalProperties: false
    SecurityDescription:
      type: object
      properties:
        Symbol:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        InstrumentClass:
          type: string
          nullable: true
      additionalProperties: false
    MarketNewsItem:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Headline:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Source:
            type: string
            nullable: true
          Url:
            type: string
            nullable: true
          Summary:
            type: string
            nullable: true
          Tags:
            type: array
            items:
              $ref: '#/components/schemas/TagGroup'
            nullable: true
          PaywallType:
            type: string
            nullable: true
        additionalProperties: false
    SecurityHeadlines:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
          Headlines:
            type: array
            items:
              $ref: '#/components/schemas/SecurityHeadline'
            nullable: true
        additionalProperties: false
    SecurityHeadlineSummaries:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
          HeadlineSummaries:
            type: array
            items:
              $ref: '#/components/schemas/SecurityHeadlineSummary'
            nullable: true
        additionalProperties: false
    SecurityHeadline:
      type: object
      properties:
        Title:
          type: string
          nullable: true
        Date:
          type: string
          nullable: true
        Time:
          type: string
          nullable: true
        UTCOffset:
          type: number
          format: double
        Source:
          type: string
          nullable: true
        Url:
          type: string
          nullable: true
        Images:
          type: array
          items:
            type: string
          nullable: true
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagGroup'
          nullable: true
        PaywallType:
          type: string
          nullable: true
        Summary:
          type: string
          nullable: true
      additionalProperties: false
    MarketHeadline:
      type: object
      properties:
        Securities:
          type: array
          items:
            $ref: '#/components/schemas/Security'
          nullable: true
        Title:
          type: string
          nullable: true
        Date:
          type: string
          nullable: true
        Time:
          type: string
          nullable: true
        UTCOffset:
          type: number
          format: double
        Source:
          type: string
          nullable: true
        Url:
          type: string
          nullable: true
        Images:
          type: array
          items:
            type: string
          nullable: true
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagGroup'
          nullable: true
        PaywallType:
          type: string
          nullable: true
        Summary:
          type: string
          nullable: true
      additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      type: string
    MarketHeadlineSummary:
      allOf:
      - $ref: '#/components/schemas/MarketHeadline'
      - type: object
        properties:
          Summary:
            type: string
            nullable: true
          PaywallType:
            type: string
            nullable: true
        additionalProperties: false
    TagGroup:
      type: object
      properties:
        TagType:
          type: string
          nullable: true
        TagValues:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
    ExchangeList:
      type: object
      properties:
        ExchangeDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeDescription'
          nullable: true
      additionalProperties: false
    MarketHeadlines:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Headlines:
            type: array
            items:
              $ref: '#/components/schemas/MarketHeadline'
            nullable: true
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query