Xignite Global Metals API

Spot prices, bars, and historical rates for precious metals such as gold, silver, platinum, and palladium from the globalmetals.xignite.com service.

OpenAPI Specification

xignite-xigniteglobalmetals-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteGlobalMetals API
  version: 1.0.3
servers:
- url: https://globalmetals.xignite.com
security:
- basic: []
tags:
- name: XigniteGlobalMetals
paths:
  /xGlobalMetals/ListMetals:
    get:
      tags:
      - XigniteGlobalMetals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metals'
            text/json:
              schema:
                $ref: '#/components/schemas/Metals'
            application/xml:
              schema:
                $ref: '#/components/schemas/Metals'
            text/xml:
              schema:
                $ref: '#/components/schemas/Metals'
            text/csv:
              schema:
                $ref: '#/components/schemas/Metals'
  /xGlobalMetals/GetRealTimeMetalQuote:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetalQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/MetalQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/MetalQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/MetalQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/MetalQuote'
  /xGlobalMetals/GetRealTimeMetalQuotes:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbols
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetalQuote'
  /xGlobalMetals/GetRealTimeExtendedMetalQuote:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedMetalQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/ExtendedMetalQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/ExtendedMetalQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/ExtendedMetalQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/ExtendedMetalQuote'
  /xGlobalMetals/GetHistoricalMetalQuote:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: FixingTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetBar:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: AsOfTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bar'
            text/json:
              schema:
                $ref: '#/components/schemas/Bar'
            application/xml:
              schema:
                $ref: '#/components/schemas/Bar'
            text/xml:
              schema:
                $ref: '#/components/schemas/Bar'
            text/csv:
              schema:
                $ref: '#/components/schemas/Bar'
  /xGlobalMetals/GetBars:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      - name: TickPrecision
        in: query
        schema:
          type: string
      - name: TickPeriods
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bar'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bar'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bar'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bar'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bar'
  /xGlobalMetals/GetBaseMetalPrice:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: MetalType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseMetalPrice'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseMetalPrice'
            application/xml:
              schema:
                $ref: '#/components/schemas/BaseMetalPrice'
            text/xml:
              schema:
                $ref: '#/components/schemas/BaseMetalPrice'
            text/csv:
              schema:
                $ref: '#/components/schemas/BaseMetalPrice'
  /xGlobalMetals/GetChartBars:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: StartTime
        in: query
        schema:
          type: string
      - name: EndTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      - name: Precision
        in: query
        schema:
          type: string
      - name: Period
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetalChartBars'
            text/json:
              schema:
                $ref: '#/components/schemas/MetalChartBars'
            application/xml:
              schema:
                $ref: '#/components/schemas/MetalChartBars'
            text/xml:
              schema:
                $ref: '#/components/schemas/MetalChartBars'
            text/csv:
              schema:
                $ref: '#/components/schemas/MetalChartBars'
  /xGlobalMetals/GetHistoricalLondonFixingRange:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: FixingType
        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:
                type: array
                items:
                  $ref: '#/components/schemas/LondonFixing'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LondonFixing'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LondonFixing'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LondonFixing'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LondonFixing'
  /xGlobalMetals/GetHistoricalMetalQuotes:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbols
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: FixingTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetHistoricalMetalQuotesRange:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      - name: FixingTime
        in: query
        schema:
          type: string
      - name: PeriodType
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetLatestHistoricalMetalQuote:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: FixingTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetLatestHistoricalMetalQuotes:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbols
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: FixingTime
        in: query
        schema:
          type: string
      - name: PriceType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetLondonFixing:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LondonFixing'
            text/json:
              schema:
                $ref: '#/components/schemas/LondonFixing'
            application/xml:
              schema:
                $ref: '#/components/schemas/LondonFixing'
            text/xml:
              schema:
                $ref: '#/components/schemas/LondonFixing'
            text/csv:
              schema:
                $ref: '#/components/schemas/LondonFixing'
  /xGlobalMetals/GetLondonHistoricalMetalQuotesRange:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Symbol
        in: query
        schema:
          type: string
      - name: Currency
        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:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalMetalQuote'
  /xGlobalMetals/GetTopIndustryHeadlines:
    get:
      tags:
      - XigniteGlobalMetals
      parameters:
      - name: Count
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarketNews'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarketNews'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarketNews'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarketNews'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MarketNews'
components:
  schemas:
    LondonFixing:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          QuoteType:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Fixing:
            type: string
            nullable: true
          Price:
            type: number
            format: double
          Unit:
            type: string
            nullable: true
          Source:
            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
    HistoricalMetalQuote:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          QuoteType:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
          StartDate:
            type: string
            nullable: true
          StartTime:
            type: string
            nullable: true
          EndDate:
            type: string
            nullable: true
          EndTime:
            type: string
            nullable: true
          Open:
            type: number
            format: double
          High:
            type: number
            format: double
          Low:
            type: number
            format: double
          Close:
            type: number
            format: double
          Average:
            type: number
            format: double
        additionalProperties: false
    Metals:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          MetalList:
            type: array
            items:
              $ref: '#/components/schemas/Metal'
            nullable: true
        additionalProperties: false
    ExtendedMetalQuote:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          Unit:
            type: string
            nullable: true
          QuoteType:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Bid:
            type: number
            format: double
          Ask:
            type: number
            format: double
          Spread:
            type: number
            format: double
          Open:
            type: number
            format: double
          High:
            type: number
            format: double
          Low:
            type: number
            format: double
          Close:
            type: number
            format: double
          Average:
            type: number
            format: double
          PreviousClose:
            type: number
            format: double
          PreviousCloseDate:
            type: string
            nullable: true
          Change:
            type: number
            format: double
          PercentChange:
            type: number
            format: double
          Source:
            type: string
            nullable: true
        additionalProperties: false
    MarketNews:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Headline:
            type: string
            nullable: true
          Source:
            type: string
            nullable: true
          Summary:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Url:
            type: string
            nullable: true
        additionalProperties: false
    Bar:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Symbol:
            type: string
            nullable: true
          StartDate:
            type: string
            nullable: true
          StartTime:
            type: string
            nullable: true
          EndDate:
            type: string
            nullable: true
          EndTime:
            type: string
            nullable: true
          Open:
            type: number
            format: double
          High:
            type: number
            format: double
          Low:
            type: number
            format: double
          Close:
            type: number
            format: double
          Average:
            type: number
            format: double
          Volume:
            type: number
            format: double
        additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      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
    Metal:
      type: object
      properties:
        Name:
          type: string
          nullable: true
        Symbol:
          type: string
          nullable: true
        Type:
          type: string
          nullable: true
        Active:
          type: boolean
        Message:
          type: string
          nullable: true
      additionalProperties: false
    MetalDescription:
      type: object
      properties:
        Symbol:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        Unit:
          type: string
          nullable: true
        Type:
          type: string
          nullable: true
      additionalProperties: false
    MetalChartBars:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Timing:
            type: string
            nullable: true
          PriceType:
            type: string
            nullable: true
          MetalDescription:
            allOf:
            - $ref: '#/components/schemas/MetalDescription'
            nullable: true
          ChartBars:
            type: array
            items:
              $ref: '#/components/schemas/ChartBar'
            nullable: true
        additionalProperties: false
    MetalQuote:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          Unit:
            type: string
            nullable: true
          QuoteType:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Bid:
            type: number
            format: double
          Mid:
            type: number
            format: double
          Ask:
            type: number
            format: double
          Spread:
            type: number
            format: double
          Source:
            type: string
            nullable: true
        additionalProperties: false
    BaseMetalPrice:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Name:
            type: string
            nullable: true
          Symbol:
            type: string
            nullable: true
          Currency:
            type: string
            nullable: true
          Date:
            type: string
            nullable: true
          Time:
            type: string
            nullable: true
          Price:
            type: number
            format: double
          Unit:
            type: string
            nullable: true
          Source:
            type: string
            nullable: true
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query