openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteGlobalIndices API
  version: 1.0.3
servers:
- url: https://globalindices.xignite.com
security:
- basic: []
tags:
- name: XigniteGlobalIndices
paths:
  /xGlobalIndices/ListIndexGroups:
    get:
      tags:
      - XigniteGlobalIndices
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexGroup'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexGroup'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexGroup'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexGroup'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexGroup'
  /xGlobalIndices/ListIndices:
    get:
      tags:
      - XigniteGlobalIndices
      parameters:
      - name: IndexGroup
        in: query
        schema:
          type: string
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: NextPage
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexSummaryList'
            text/json:
              schema:
                $ref: '#/components/schemas/IndexSummaryList'
            application/xml:
              schema:
                $ref: '#/components/schemas/IndexSummaryList'
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexSummaryList'
            text/csv:
              schema:
                $ref: '#/components/schemas/IndexSummaryList'
  /xGlobalIndices/ListIndicesByIndexGroup:
    get:
      tags:
      - XigniteGlobalIndices
      parameters:
      - name: IndexGroup
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
  /xGlobalIndices/GetIndexSymbolMappingByOldSymbol:
    get:
      tags:
      - XigniteGlobalIndices
      parameters:
      - name: OldSymbol
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexSymbolMapping'
            text/json:
              schema:
                $ref: '#/components/schemas/IndexSymbolMapping'
            application/xml:
              schema:
                $ref: '#/components/schemas/IndexSymbolMapping'
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexSymbolMapping'
            text/csv:
              schema:
                $ref: '#/components/schemas/IndexSymbolMapping'
  /xGlobalIndices/GetIndexSymbolMappingsByOldSymbols:
    get:
      tags:
      - XigniteGlobalIndices
      parameters:
      - name: OldSymbols
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexSymbolMapping'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexSymbolMapping'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexSymbolMapping'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexSymbolMapping'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexSymbolMapping'
  /xGlobalIndices/SearchIndicesByName:
    get:
      tags:
      - XigniteGlobalIndices
      parameters:
      - name: IndexName
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexDescription'
  /xGlobalIndices/GetDelayedIndexValue:
    get:
      tags:
      - XigniteGlobalIndices
      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/Weeks.IndexValue'
            text/json:
              schema:
                $ref: '#/components/schemas/Weeks.IndexValue'
            application/xml:
              schema:
                $ref: '#/components/schemas/Weeks.IndexValue'
            text/xml:
              schema:
                $ref: '#/components/schemas/Weeks.IndexValue'
            text/csv:
              schema:
                $ref: '#/components/schemas/Weeks.IndexValue'
  /xGlobalIndices/GetDelayedIndicesValue:
    get:
      tags:
      - XigniteGlobalIndices
      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/Weeks.IndexValue'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Weeks.IndexValue'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Weeks.IndexValue'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Weeks.IndexValue'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Weeks.IndexValue'
  /xGlobalIndices/GetIndexBar:
    get:
      tags:
      - XigniteGlobalIndices
      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/BarPrecision'
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexBar'
            text/json:
              schema:
                $ref: '#/components/schemas/IndexBar'
            application/xml:
              schema:
                $ref: '#/components/schemas/IndexBar'
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexBar'
            text/csv:
              schema:
                $ref: '#/components/schemas/IndexBar'
  /xGlobalIndices/GetIndexBars:
    get:
      tags:
      - XigniteGlobalIndices
      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/BarPrecision'
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexBars'
            text/json:
              schema:
                $ref: '#/components/schemas/IndexBars'
            application/xml:
              schema:
                $ref: '#/components/schemas/IndexBars'
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexBars'
            text/csv:
              schema:
                $ref: '#/components/schemas/IndexBars'
  /xGlobalIndices/GetChartBars:
    get:
      tags:
      - XigniteGlobalIndices
      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/IndexChartBars'
            text/json:
              schema:
                $ref: '#/components/schemas/IndexChartBars'
            application/xml:
              schema:
                $ref: '#/components/schemas/IndexChartBars'
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexChartBars'
            text/csv:
              schema:
                $ref: '#/components/schemas/IndexChartBars'
components:
  schemas:
    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
    Weeks.IndexQuote:
      allOf:
      - $ref: '#/components/schemas/IndexQuote'
      - type: object
        properties:
          High52Weeks:
            type: number
            format: double
          Low52Weeks:
            type: number
            format: double
        additionalProperties: false
    IndexBars:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Index:
            allOf:
            - $ref: '#/components/schemas/IndexDescriptionDto'
            nullable: true
          Bars:
            type: array
            items:
              $ref: '#/components/schemas/Bar'
            nullable: true
        additionalProperties: false
    BarPrecision:
      enum:
      - Minutes
      - Hours
      type: string
    Weeks.IndexValue:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Identifier:
            type: string
            nullable: true
          IdentifierType:
            type: string
            nullable: true
          Index:
            allOf:
            - $ref: '#/components/schemas/IndexDescriptionDto'
            nullable: true
          Value:
            allOf:
            - $ref: '#/components/schemas/Weeks.IndexQuote'
            nullable: true
        additionalProperties: false
    IndexDescription:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          IndexName:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          IndexGroup:
            type: string
            nullable: true
          Valoren:
            type: integer
            format: int32
          Currency:
            type: string
            nullable: true
        additionalProperties: false
    IdentifierTypes:
      enum:
      - Symbol
      - CIK
      - CUSIP
      - ISIN
      - Valoren
      - SEDOL
      - FIGI
      - CompositeFIGI
      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
      additionalProperties: false
    IndexBar:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Index:
            allOf:
            - $ref: '#/components/schemas/IndexDescriptionDto'
            nullable: true
          Bar:
            allOf:
            - $ref: '#/components/schemas/Bar'
            nullable: true
        additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      type: string
    IndexSummary:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          IndexName:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          IndexGroup:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
        additionalProperties: false
    IndexQuote:
      type: object
      properties:
        Date:
          type: string
          nullable: true
        Time:
          type: string
          nullable: true
        UTCOffset:
          type: number
          format: double
        Volume:
          type: number
          format: double
        Open:
          type: number
          format: double
        High:
          type: number
          format: double
        Low:
          type: number
          format: double
        Last:
          type: number
          format: double
        Close:
          type: number
          format: double
        ChangeFromOpen:
          type: number
          format: double
        PercentChangeFromOpen:
          type: number
          format: double
        PreviousClose:
          type: number
          format: double
        PreviousCloseDate:
          type: string
          nullable: true
        ChangeFromPreviousClose:
          type: number
          format: double
        PercentChangeFromPreviousClose:
          type: number
          format: double
      additionalProperties: false
    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
    IndexDescriptionDto:
      type: object
      properties:
        IndexName:
          type: string
          nullable: true
        Symbol:
          type: string
          nullable: true
        IndexGroup:
          type: string
          nullable: true
        Valoren:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
      additionalProperties: false
    IndexGroup:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Description:
            type: string
            nullable: true
        additionalProperties: false
    IndexSymbolMapping:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Index:
            allOf:
            - $ref: '#/components/schemas/IndexDescriptionDto'
            nullable: true
          OldSymbol:
            type: string
            nullable: true
        additionalProperties: false
    IndexSummaryList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          IndexSummaries:
            type: array
            items:
              $ref: '#/components/schemas/IndexSummary'
            nullable: true
          NextPage:
            type: string
            nullable: true
        additionalProperties: false
    IndexChartBars:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Timing:
            type: string
            nullable: true
          Index:
            allOf:
            - $ref: '#/components/schemas/IndexDescriptionDto'
            nullable: true
          ChartBars:
            type: array
            items:
              $ref: '#/components/schemas/ChartBar'
            nullable: true
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query