Xignite Crypto API
Cryptocurrency market data including quotes, chart bars, and historical prices for digital assets from the crypto.xignite.com service.
OpenAPI Specification
openapi: 3.0.4
info:
title: XigniteBonds CloudAlerts XigniteCrypto API
version: 1.0.3
servers:
- url: https://crypto.xignite.com
security:
- basic: []
tags:
- name: XigniteCrypto
paths:
/xCrypto/GetHistoricalQuoteRange:
get:
tags:
- XigniteCrypto
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
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoHistoricalQuoteRange'
text/json:
schema:
$ref: '#/components/schemas/CryptoHistoricalQuoteRange'
application/xml:
schema:
$ref: '#/components/schemas/CryptoHistoricalQuoteRange'
text/xml:
schema:
$ref: '#/components/schemas/CryptoHistoricalQuoteRange'
text/csv:
schema:
$ref: '#/components/schemas/CryptoHistoricalQuoteRange'
/xCrypto/GetExchangeHistoricalQuoteRange:
get:
tags:
- XigniteCrypto
parameters:
- name: Identifier
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
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeHistoricalQuote'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeHistoricalQuote'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeHistoricalQuote'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeHistoricalQuote'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeHistoricalQuote'
/xCrypto/GetHistoricalQuotes:
get:
tags:
- XigniteCrypto
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
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoHistoricalQuote'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoHistoricalQuote'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoHistoricalQuote'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoHistoricalQuote'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoHistoricalQuote'
/xCrypto/GetQuotes:
get:
tags:
- XigniteCrypto
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/CryptoQuote'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoQuote'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoQuote'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoQuote'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoQuote'
/xCrypto/GetReferenceData:
get:
tags:
- XigniteCrypto
parameters:
- name: Symbols
in: query
schema:
type: string
- name: DataTypes
in: query
schema:
type: string
- name: AsOfDate
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoReferenceData'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoReferenceData'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoReferenceData'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoReferenceData'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoReferenceData'
/xCrypto/GetTopCryptoHeadlines:
get:
tags:
- XigniteCrypto
parameters:
- name: Symbols
in: query
schema:
type: string
- name: ExcludeCategories
in: query
schema:
type: string
- name: StartDateTime
in: query
schema:
type: string
- name: Count
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TopCryptoHeadlines'
text/json:
schema:
$ref: '#/components/schemas/TopCryptoHeadlines'
application/xml:
schema:
$ref: '#/components/schemas/TopCryptoHeadlines'
text/xml:
schema:
$ref: '#/components/schemas/TopCryptoHeadlines'
text/csv:
schema:
$ref: '#/components/schemas/TopCryptoHeadlines'
/xCrypto/GetTopMarketHeadlines:
get:
tags:
- XigniteCrypto
parameters:
- name: NewsSources
in: query
schema:
type: string
- name: Categories
in: query
schema:
type: string
- name: ExcludeCategories
in: query
schema:
type: string
- name: StartDateTime
in: query
schema:
type: string
- name: Count
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TopMarketHeadlines'
text/json:
schema:
$ref: '#/components/schemas/TopMarketHeadlines'
application/xml:
schema:
$ref: '#/components/schemas/TopMarketHeadlines'
text/xml:
schema:
$ref: '#/components/schemas/TopMarketHeadlines'
text/csv:
schema:
$ref: '#/components/schemas/TopMarketHeadlines'
/xCrypto/ListCryptos:
get:
tags:
- XigniteCrypto
parameters:
- name: Exchange
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoList'
text/json:
schema:
$ref: '#/components/schemas/CryptoList'
application/xml:
schema:
$ref: '#/components/schemas/CryptoList'
text/xml:
schema:
$ref: '#/components/schemas/CryptoList'
text/csv:
schema:
$ref: '#/components/schemas/CryptoList'
/xCrypto/ListExchanges:
get:
tags:
- XigniteCrypto
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'
/xCrypto/ListNewsCategories:
get:
tags:
- XigniteCrypto
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NewsCategoryList'
text/json:
schema:
$ref: '#/components/schemas/NewsCategoryList'
application/xml:
schema:
$ref: '#/components/schemas/NewsCategoryList'
text/xml:
schema:
$ref: '#/components/schemas/NewsCategoryList'
text/csv:
schema:
$ref: '#/components/schemas/NewsCategoryList'
/xCrypto/ListNewsSources:
get:
tags:
- XigniteCrypto
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NewsSourceList'
text/json:
schema:
$ref: '#/components/schemas/NewsSourceList'
application/xml:
schema:
$ref: '#/components/schemas/NewsSourceList'
text/xml:
schema:
$ref: '#/components/schemas/NewsSourceList'
text/csv:
schema:
$ref: '#/components/schemas/NewsSourceList'
/xCrypto/ListReferenceData:
get:
tags:
- XigniteCrypto
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReferenceDataList'
text/json:
schema:
$ref: '#/components/schemas/ReferenceDataList'
application/xml:
schema:
$ref: '#/components/schemas/ReferenceDataList'
text/xml:
schema:
$ref: '#/components/schemas/ReferenceDataList'
text/csv:
schema:
$ref: '#/components/schemas/ReferenceDataList'
/xCrypto/GetChartBars:
get:
tags:
- XigniteCrypto
parameters:
- name: Identifier
in: query
schema:
type: string
- 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: Currency
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoChartBars'
text/json:
schema:
$ref: '#/components/schemas/CryptoChartBars'
application/xml:
schema:
$ref: '#/components/schemas/CryptoChartBars'
text/xml:
schema:
$ref: '#/components/schemas/CryptoChartBars'
text/csv:
schema:
$ref: '#/components/schemas/CryptoChartBars'
/xCrypto/GetExchangeQuotes:
get:
tags:
- XigniteCrypto
parameters:
- name: Identifiers
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/CryptoExchangeQuote'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeQuote'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeQuote'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeQuote'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/CryptoExchangeQuote'
/xCrypto/ListTopCoins:
get:
tags:
- XigniteCrypto
parameters:
- name: Type
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/TopCoinList'
text/json:
schema:
$ref: '#/components/schemas/TopCoinList'
application/xml:
schema:
$ref: '#/components/schemas/TopCoinList'
text/xml:
schema:
$ref: '#/components/schemas/TopCoinList'
text/csv:
schema:
$ref: '#/components/schemas/TopCoinList'
components:
schemas:
CryptoExchangeHistoricalQuote:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
ExchangeHistoricalQuote:
allOf:
- $ref: '#/components/schemas/ExchangeHistoricalQuote'
nullable: true
additionalProperties: false
CryptoList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Cryptos:
type: array
items:
$ref: '#/components/schemas/Crypto'
nullable: true
additionalProperties: false
Crypto:
type: object
properties:
Symbol:
type: string
nullable: true
Name:
type: string
nullable: true
additionalProperties: false
NewsHeadline:
type: object
properties:
DateTime:
type: string
nullable: true
Title:
type: string
nullable: true
Url:
type: string
nullable: true
NewsSource:
allOf:
- $ref: '#/components/schemas/NewsSource'
nullable: true
Summary:
type: string
nullable: true
ImageUrl:
type: string
nullable: true
Tags:
type: array
items:
type: string
nullable: true
Categories:
type: array
items:
type: string
nullable: true
additionalProperties: false
CryptoQuote:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Quote:
allOf:
- $ref: '#/components/schemas/Quote'
nullable: true
additionalProperties: false
CryptoHistoricalQuoteRange:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
CryptoHistoricalQuotes:
type: array
items:
$ref: '#/components/schemas/HistoricalQuote'
nullable: true
additionalProperties: false
ChartBar:
type: object
properties:
StartTime:
type: string
nullable: true
EndTime:
type: string
nullable: true
Open:
type: number
format: decimal
High:
type: number
format: decimal
Low:
type: number
format: decimal
Close:
type: number
format: decimal
Trades:
type: integer
format: int32
Volume:
type: number
format: decimal
TWAP:
type: number
format: decimal
VWAP:
type: number
format: decimal
additionalProperties: false
ExchangeList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Exchanges:
type: array
items:
$ref: '#/components/schemas/Exchange'
nullable: true
additionalProperties: false
NewsSource:
type: object
properties:
Code:
type: string
nullable: true
Name:
type: string
nullable: true
Language:
type: string
nullable: true
Image:
type: string
nullable: true
additionalProperties: false
NewsSourceList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
NewsSources:
type: array
items:
$ref: '#/components/schemas/NewsSource'
nullable: true
additionalProperties: false
NewsCategoryList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
NewsCategories:
type: array
items:
$ref: '#/components/schemas/NewsCategory'
nullable: true
additionalProperties: false
TopMarketHeadlines:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
NewsHeadlines:
type: array
items:
$ref: '#/components/schemas/NewsHeadline'
nullable: true
additionalProperties: false
TopCryptoHeadlines:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
NewsHeadlines:
type: array
items:
$ref: '#/components/schemas/NewsHeadline'
nullable: true
additionalProperties: false
OutcomeTypes:
enum:
- Success
- SystemError
- RequestError
- RegistrationError
type: string
TopCoinList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
TopCoins:
type: array
items:
$ref: '#/components/schemas/TopCoin'
nullable: true
additionalProperties: false
ExchangeHistoricalQuote:
type: object
properties:
Symbol:
type: string
nullable: true
Exchange:
type: string
nullable: true
Identifier:
type: string
nullable: true
StartDateTime:
type: string
nullable: true
EndDateTime:
type: string
nullable: true
Open:
type: number
format: decimal
High:
type: number
format: decimal
Low:
type: number
format: decimal
Close:
type: number
format: decimal
Bid:
type: number
format: decimal
nullable: true
Ask:
type: number
format: decimal
nullable: true
Volume:
type: number
format: decimal
Change:
type: number
format: decimal
PercentChange:
type: number
format: decimal
Currency:
type: string
nullable: true
additionalProperties: false
TopCoin:
type: object
properties:
Symbol:
type: string
nullable: true
Name:
type: string
nullable: true
Currency:
type: string
nullable: true
MarketCapitalization:
type: number
format: decimal
Volume:
type: number
format: decimal
additionalProperties: false
ReferenceData:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
AsOfDate:
type: string
nullable: true
Type:
type: string
nullable: true
Value:
type: string
nullable: true
LastUpdated:
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
CryptoChartBars:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Symbol:
type: string
nullable: true
Currency:
type: string
nullable: true
Exchange:
type: string
nullable: true
ChartBars:
type: array
items:
$ref: '#/components/schemas/ChartBar'
nullable: true
additionalProperties: false
ExchangeQuote:
type: object
properties:
Symbol:
type: string
nullable: true
Exchange:
type: string
nullable: true
Identifier:
type: string
nullable: true
DateTime:
type: string
nullable: true
Open:
type: number
format: decimal
High:
type: number
format: decimal
Low:
type: number
format: decimal
Last:
type: number
format: decimal
VolumeCurrentHour:
type: number
format: decimal
Volume24Hour:
type: number
format: decimal
LastVolume:
type: number
format: decimal
Bid:
type: number
format: decimal
nullable: true
BidSize:
type: number
format: decimal
nullable: true
BidTime:
type: string
nullable: true
Ask:
type: number
format: decimal
nullable: true
AskSize:
type: number
format: decimal
nullable: true
AskTime:
type: string
nullable: true
Change:
type: number
format: decimal
PercentChange:
type: number
format: decimal
Currency:
type: string
nullable: true
additionalProperties: false
ReferenceDescription:
type: object
properties:
Description:
type: string
nullable: true
Name:
type: string
nullable: true
Type:
type: string
nullable: true
additionalProperties: false
CryptoReferenceData:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Symbol:
type: string
nullable: true
ReferenceDataSet:
type: array
items:
$ref: '#/components/schemas/ReferenceData'
nullable: true
additionalProperties: false
HistoricalQuote:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
Symbol:
type: string
nullable: true
StartDateTime:
type: string
nullable: true
EndDateTime:
type: string
nullable: true
Open:
type: number
format: decimal
High:
type: number
format: decimal
Low:
type: number
format: decimal
Close:
type: number
format: decimal
Volume:
type: number
format: decimal
Change:
type: number
format: decimal
PercentChange:
type: number
format: decimal
Currency:
type: string
nullable: true
additionalProperties: false
NewsCategory:
type: object
additionalProperties: false
CryptoExchangeQuote:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
ExchangeQuote:
allOf:
- $ref: '#/components/schemas/ExchangeQuote'
nullable: true
additionalProperties: false
Exchange:
type: object
properties:
Name:
type: string
nullable: true
Code:
type: string
nullable: true
Description:
type: string
nullable: true
Country:
type: string
nullable: true
additionalProperties: false
ReferenceDataList:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
ReferenceDescriptions:
type: array
items:
$ref: '#/components/schemas/ReferenceDescription'
nullable: true
additionalProperties: false
Quote:
type: object
properties:
Symbol:
type: string
nullable: true
Exchange:
type: string
nullable: true
DateTime:
type: string
nullable: true
Open:
type: number
format: decimal
High:
type: number
format: decimal
Low:
type: number
format: decimal
Last:
type: number
format: decimal
Median:
type: number
format: decimal
Volume:
type: number
format: decimal
MarketCapitalization:
type: number
format: decimal
Change:
type: number
format: decimal
PercentChange:
type: number
format: decimal
High52Weeks:
type: number
format: decimal
Low52Weeks:
type: number
format: decimal
Currency:
type: string
nullable: true
additionalProperties: false
CryptoHistoricalQuote:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
HistoricalQuote:
allOf:
- $ref: '#/components/schemas/HistoricalQuote'
nullable: true
additionalProperties: false
securitySchemes:
basic:
type: apiKey
description: Token for your account.
name: _token
in: query