Xignite Global Real-Time API

openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteGlobalRealTime API
  version: 1.0.3
servers:
- url: https://globalrealtime.xignite.com
security:
- basic: []
tags:
- name: XigniteGlobalRealTime
paths:
  /v3/xGlobalRealTime/ListSymbolChanges:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Exchange
        in: query
        schema:
          type: string
      - name: ChangesSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SymbolChangeList'
            text/json:
              schema:
                $ref: '#/components/schemas/SymbolChangeList'
            application/xml:
              schema:
                $ref: '#/components/schemas/SymbolChangeList'
            text/xml:
              schema:
                $ref: '#/components/schemas/SymbolChangeList'
            text/csv:
              schema:
                $ref: '#/components/schemas/SymbolChangeList'
  /v3/xGlobalRealTime/ListSymbols:
    get:
      tags:
      - XigniteGlobalRealTime
      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'
  /v3/xGlobalRealTime/ListExchanges:
    get:
      tags:
      - XigniteGlobalRealTime
      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'
  /v3/xGlobalRealTime/GetGlobalExtendedQuote:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalExtendedQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalExtendedQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/GlobalExtendedQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalExtendedQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/GlobalExtendedQuote'
  /v3/xGlobalRealTime/GetGlobalRealTimeQuote:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/GlobalQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/GlobalQuote'
  /v3/xGlobalRealTime/GetGlobalExtendedQuotes:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalExtendedQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalExtendedQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalExtendedQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalExtendedQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalExtendedQuote'
  /v3/xGlobalRealTime/GetGlobalRealTimeQuotes:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalQuote'
  /v3/xGlobalRealTime/GetAuctionPrices:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAuctionQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAuctionQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAuctionQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAuctionQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAuctionQuote'
  /v3/xGlobalRealTime/GetGlobalRealTimeVWAP:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/json:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            application/xml:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/xml:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/csv:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
  /v3/xGlobalRealTime/GetTopMarketMovers:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: MarketMoverType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/MarketMoverTypes'
      - name: NumberOfMarketMovers
        in: query
        schema:
          type: integer
          format: int32
      - name: Exchanges
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketMovers'
            text/json:
              schema:
                $ref: '#/components/schemas/MarketMovers'
            application/xml:
              schema:
                $ref: '#/components/schemas/MarketMovers'
            text/xml:
              schema:
                $ref: '#/components/schemas/MarketMovers'
            text/csv:
              schema:
                $ref: '#/components/schemas/MarketMovers'
  /v3/xGlobalRealTime/GetChartBars:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      - name: Precision
        in: query
        schema:
          type: string
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      - name: AdjustmentMethod
        in: query
        schema:
          type: string
      - name: IncludeExtended
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquityChartBars'
            text/json:
              schema:
                $ref: '#/components/schemas/EquityChartBars'
            application/xml:
              schema:
                $ref: '#/components/schemas/EquityChartBars'
            text/xml:
              schema:
                $ref: '#/components/schemas/EquityChartBars'
            text/csv:
              schema:
                $ref: '#/components/schemas/EquityChartBars'
  /v3/xGlobalRealTime/GetBars:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      - name: Precision
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/TickPrecisions'
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalBars'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalBars'
            application/xml:
              schema:
                $ref: '#/components/schemas/GlobalBars'
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalBars'
            text/csv:
              schema:
                $ref: '#/components/schemas/GlobalBars'
  /v3/xGlobalRealTime/GetBar:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      - name: EndTime
        in: query
        schema:
          type: string
      - name: Precision
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/TickPrecisions'
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalBar'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalBar'
            application/xml:
              schema:
                $ref: '#/components/schemas/GlobalBar'
            text/xml:
              schema:
                $ref: '#/components/schemas/GlobalBar'
            text/csv:
              schema:
                $ref: '#/components/schemas/GlobalBar'
  /v3/xGlobalRealTime/GetGlobalIntradayVWAP:
    get:
      tags:
      - XigniteGlobalRealTime
      parameters:
      - name: Identifier
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          allOf:
          - $ref: '#/components/schemas/IdentifierTypes'
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/json:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            application/xml:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/xml:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
            text/csv:
              schema:
                $ref: '#/components/schemas/IntradayVWAP'
components:
  schemas:
    MarketMovers:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          MarketMoverType:
            type: string
            nullable: true
          NumberOfMarketMovers:
            type: integer
            format: int32
          Exchanges:
            type: string
            nullable: true
          InstrumentClass:
            type: string
            nullable: true
          Universe:
            type: string
            nullable: true
          Movers:
            type: array
            items:
              $ref: '#/components/schemas/MarketMover'
            nullable: true
        additionalProperties: false
    IntradayVWAPTypes:
      enum:
      - RealTime
      - Delayed
      - OneMinute
      - FiveMinute
      - TenMinute
      - ThirtyMinute
      - OneHour
      - Period
      type: string
    MarketMoverTypes:
      enum:
      - PercentGainers
      - PercentLosers
      - MostActive
      type: string
    ChartBar:
      type: object
      properties:
        StartDate:
          type: string
          nullable: true
        StartTime:
          type: string
          nullable: true
        EndDate:
          type: string
          nullable: true
        EndTime:
          type: string
          nullable: true
        UTCOffset:
          type: number
          format: double
        Open:
          type: number
          format: double
        High:
          type: number
          format: double
        Low:
          type: number
          format: double
        Close:
          type: number
          format: double
        Volume:
          type: number
          format: double
        Trades:
          type: integer
          format: int32
        TWAP:
          type: number
          format: double
        VWAP:
          type: number
          format: double
        Currency:
          type: string
          nullable: true
        Session:
          type: string
          nullable: true
        AdjustmentRatio:
          type: number
          format: double
      additionalProperties: false
    GlobalBars:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
          Bars:
            type: array
            items:
              $ref: '#/components/schemas/Bar'
            nullable: true
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
        additionalProperties: false
    ExchangeList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          ExchangeDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/ExchangeDescription'
            nullable: true
        additionalProperties: false
    SymbolList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Exchange:
            allOf:
            - $ref: '#/components/schemas/ExchangeDescription'
            nullable: true
          SecurityDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/SecurityDescription'
            nullable: true
        additionalProperties: false
    SecurityDescription:
      type: object
      properties:
        Symbol:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
      additionalProperties: false
    TickPrecisions:
      enum:
      - Seconds
      - Minutes
      - Hours
      type: string
    Bar:
      type: object
      properties:
        StartDate:
          type: string
          nullable: true
        StartTime:
          type: string
          nullable: true
        EndDate:
          type: string
          nullable: true
        EndTime:
          type: string
          nullable: true
        UTCOffset:
          type: number
          format: double
        Open:
          type: number
          format: double
        High:
          type: number
          format: double
        Low:
          type: number
          format: double
        Close:
          type: number
          format: double
        Volume:
          type: number
          format: double
        Trades:
          type: integer
          format: int32
        TWAP:
          type: number
          format: double
        VWAP:
          type: number
          format: double
      additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      type: string
    SymbolChange:
      type: object
      properties:
        Symbol:
          type: string
          nullable: true
        OldSymbol:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        OldName:
          type: string
          nullable: true
        Exchange:
          type: string
          nullable: true
        OldExchange:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        OldCurrency:
          type: string
          nullable: true
        Type:
          type: string
          nullable: true
        InstrumentClass:
          type: string
          nullable: true
      additionalProperties: false
    GlobalQuote:
      allOf:
      - $ref: '#/components/schemas/QuoteWithSecurity'
      - type: object
        properties:
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          UTCOffset:
            type: number
            format: double
          Open:
            type: number
            format: double
          Close:
            type: number
            format: double
          High:
            type: number
            format: double
          Low:
            type: number
            format: double
          Last:
            type: number
            format: double
          LastSize:
            type: number
            format: double
          Volume:
            type: number
            format: double
          PreviousClose:
            type: number
            format: double
          PreviousCloseDate:
            type: string
            nullable: true
          ChangeFromPreviousClose:
            type: number
            format: double
          PercentChangeFromPreviousClose:
            type: number
            format: double
          Bid:
            type: number
            format: double
          BidSize:
            type: number
            format: double
          BidDate:
            type: string
            nullable: true
          BidTime:
            type: string
            nullable: true
          Ask:
            type: number
            format: double
          AskSize:
            type: number
            format: double
          AskDate:
            type: string
            nullable: true
          AskTime:
            type: string
            nullable: true
          High52Weeks:
            type: number
            format: double
          Low52Weeks:
            type: number
            format: double
          Currency:
            type: string
            nullable: true
          TradingHalted:
            type: boolean
          BidMarketIdentificationCode:
            type: string
            nullable: true
          AskMarketIdentificationCode:
            type: string
            nullable: true
          LastMarketIdentificationCode:
            type: string
            nullable: true
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            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
    IntradayVWAP:
      allOf:
      - $ref: '#/components/schemas/QuoteWithSecurity'
      - type: object
        properties:
          Date:
            type: string
            nullable: true
          StartTime:
            type: string
            nullable: true
          EndTime:
            type: string
            nullable: true
          UTCOffset:
            type: number
            format: double
          VWAPType:
            allOf:
            - $ref: '#/components/schemas/IntradayVWAPTypes'
          VWAP:
            type: number
            format: double
          High:
            type: number
            format: double
          Low:
            type: number
            format: double
          Average:
            type: number
            format: double
          Amount:
            type: number
            format: double
          Volume:
            type: number
            format: double
          Trades:
            type: integer
            format: int32
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
        additionalProperties: false
    GlobalBar:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Bar:
            allOf:
            - $ref: '#/components/schemas/Bar'
            nullable: true
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
        additionalProperties: false
    GlobalExtendedQuote:
      allOf:
      - $ref: '#/components/schemas/GlobalQuote'
      - type: object
        properties:
          VolumeDate:
            type: string
            nullable: true
          ExtendedHoursDate:
            type: string
            nullable: true
          ExtendedHoursTime:
            type: string
            nullable: true
          ExtendedHoursType:
            type: string
            nullable: true
          ExtendedHoursPrice:
            type: number
            format: double
          ExtendedHoursChange:
            type: number
            format: double
          ExtendedHoursPercentChange:
            type: number
            format: double
          ExtendedHoursTradeConditions:
            type: string
            nullable: true
          LimitDate:
            type: string
            nullable: true
          LimitTime:
            type: string
            nullable: true
          LimitDown:
            type: number
            format: double
          LimitUp:
            type: number
            format: double
        additionalProperties: false
    GlobalAuctionQuote:
      allOf:
      - $ref: '#/components/schemas/QuoteWithSecurity'
      - type: object
        properties:
          OpeningAuction:
            type: number
            format: double
          OpeningAuctionSize:
            type: number
            format: double
          OpeningAuctionDate:
            type: string
            nullable: true
          OpeningAuctionTime:
            type: string
            nullable: true
          ClosingAuction:
            type: number
            format: double
          ClosingAuctionSize:
            type: number
            format: double
          ClosingAuctionDate:
            type: string
            nullable: true
          ClosingAuctionTime:
            type: string
            nullable: true
          LastAuction:
            type: number
            format: double
          LastAuctionSize:
            type: number
            format: double
          PreviousClosingAuction:
            type: number
            format: double
          PreviousClosingAuctionDate:
            type: string
            nullable: true
          UTCOffset:
            type: number
            format: double
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
        additionalProperties: false
    QuoteWithSecurity:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
        additionalProperties: false
    MarketMover:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          MarketMoverType:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          Name:
            type: string
            nullable: true
          InstrumentClass:
            type: string
            nullable: true
          Market:
            type: string
            nullable: true
          MarketIdentificationCode:
            type: string
            nullable: true
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          UTCOffset:
            type: number
            format: double
          Last:
            type: number
            format: double
          ChangeFromPreviousClose:
            type: number
            format: double
          PercentChangeFromPreviousClose:
            type: number
            format: double
          Volume:
            type: number
            format: double
          Currency:
            type: string
            nullable: true
        additionalProperties: false
    ExchangeDescription:
      type: object
      properties:
        MarketIdentificationCode:
          type: string
          nullable: true
        Market:
          type: string
          nullable: true
      additionalProperties: false
    EquityChartBars:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Security:
            allOf:
            - $ref: '#/components/schemas/Security'
            nullable: true
          ChartBars:
            type: array
            items:
              $ref: '#/components/schemas/ChartBar'
            nullable: true
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
          Timing:
            type: string
            nullable: true
        additionalProperties: false
    IdentifierTypes:
      enum:
      - Symbol
      - CIK
      - CUSIP
      - ISIN
      - Valoren
      - SEDOL
      - FIGI
      - CompositeFIGI
      type: string
    SymbolChangeList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          DateTime:
            type: string
            nullable: true
          SymbolChanges:
            type: array
            items:
              $ref: '#/components/schemas/SymbolChange'
            nullable: true
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query