openapi: 3.0.4 info: title: XigniteBonds CloudAlerts XigniteGlobalOptions API version: 1.0.3 servers: - url: https://globaloptions.xignite.com security: - basic: [] tags: - name: XigniteGlobalOptions paths: /xGlobalOptions/GetOptionGreeks: get: tags: - XigniteGlobalOptions parameters: - name: Symbols in: query schema: type: string - name: SymbologyType in: query schema: type: string - name: CalculationType in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/OptionGreeks' text/json: schema: type: array items: $ref: '#/components/schemas/OptionGreeks' application/xml: schema: type: array items: $ref: '#/components/schemas/OptionGreeks' text/xml: schema: type: array items: $ref: '#/components/schemas/OptionGreeks' text/csv: schema: type: array items: $ref: '#/components/schemas/OptionGreeks' /xGlobalOptions/GetOptionGreeksByChain: get: tags: - XigniteGlobalOptions parameters: - name: IdentifierType in: query schema: type: string - name: Identifier in: query schema: type: string - name: Month in: query schema: type: string - name: Year in: query schema: type: string - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string - name: CalculationType in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/json: schema: $ref: '#/components/schemas/OptionGreeksByChain' application/xml: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/xml: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/csv: schema: $ref: '#/components/schemas/OptionGreeksByChain' /xGlobalOptions/GetAllOptionGreeksByChain: get: tags: - XigniteGlobalOptions parameters: - name: IdentifierType in: query schema: type: string - name: Identifier in: query schema: type: string - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string - name: CalculationType in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/json: schema: $ref: '#/components/schemas/OptionGreeksByChain' application/xml: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/xml: schema: $ref: '#/components/schemas/OptionGreeksByChain' text/csv: schema: $ref: '#/components/schemas/OptionGreeksByChain' /xGlobalOptions/GetAllEquityOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Options' text/json: schema: $ref: '#/components/schemas/Options' application/xml: schema: $ref: '#/components/schemas/Options' text/xml: schema: $ref: '#/components/schemas/Options' text/csv: schema: $ref: '#/components/schemas/Options' /xGlobalOptions/GetAllExtendedEquityOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedOptions' text/json: schema: $ref: '#/components/schemas/ExtendedOptions' application/xml: schema: $ref: '#/components/schemas/ExtendedOptions' text/xml: schema: $ref: '#/components/schemas/ExtendedOptions' text/csv: schema: $ref: '#/components/schemas/ExtendedOptions' /xGlobalOptions/GetBlackScholesOptionValue: get: tags: - XigniteGlobalOptions parameters: - name: Type in: query schema: allOf: - $ref: '#/components/schemas/OptionTypes' - name: StockPrice in: query schema: type: number format: double - name: StrikePrice in: query schema: type: number format: double - name: YearsToMaturity in: query schema: type: number format: double - name: RiskFreeRate in: query schema: type: number format: double - name: Volatility in: query schema: type: number format: double responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NumericResult' text/json: schema: $ref: '#/components/schemas/NumericResult' application/xml: schema: $ref: '#/components/schemas/NumericResult' text/xml: schema: $ref: '#/components/schemas/NumericResult' text/csv: schema: $ref: '#/components/schemas/NumericResult' /xGlobalOptions/GetEquityOption: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: Type in: query schema: allOf: - $ref: '#/components/schemas/OptionTypes' - name: Month in: query schema: type: integer format: int32 - name: Year in: query schema: type: integer format: int32 - name: StrikePrice in: query schema: type: number format: double - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Option' text/json: schema: $ref: '#/components/schemas/Option' application/xml: schema: $ref: '#/components/schemas/Option' text/xml: schema: $ref: '#/components/schemas/Option' text/csv: schema: $ref: '#/components/schemas/Option' /xGlobalOptions/GetEquityOptionBySymbol: get: tags: - XigniteGlobalOptions parameters: - name: Symbol in: query schema: type: string - name: SymbologyType in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Option' text/json: schema: $ref: '#/components/schemas/Option' application/xml: schema: $ref: '#/components/schemas/Option' text/xml: schema: $ref: '#/components/schemas/Option' text/csv: schema: $ref: '#/components/schemas/Option' /xGlobalOptions/GetEquityOptionBySymbols: get: tags: - XigniteGlobalOptions parameters: - name: Symbols in: query schema: type: string - name: SymbologyType in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Option' text/json: schema: type: array items: $ref: '#/components/schemas/Option' application/xml: schema: type: array items: $ref: '#/components/schemas/Option' text/xml: schema: type: array items: $ref: '#/components/schemas/Option' text/csv: schema: type: array items: $ref: '#/components/schemas/Option' /xGlobalOptions/GetEquityOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: Month in: query schema: type: integer format: int32 - name: Year in: query schema: type: integer format: int32 - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Options' text/json: schema: $ref: '#/components/schemas/Options' application/xml: schema: $ref: '#/components/schemas/Options' text/xml: schema: $ref: '#/components/schemas/Options' text/csv: schema: $ref: '#/components/schemas/Options' /xGlobalOptions/GetEquityOptionSymbol: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: Type in: query schema: allOf: - $ref: '#/components/schemas/OptionTypes' - name: Month in: query schema: type: integer format: int32 - name: Year in: query schema: type: integer format: int32 - name: StrikePrice in: query schema: type: number format: double - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptionSymbol' text/json: schema: $ref: '#/components/schemas/OptionSymbol' application/xml: schema: $ref: '#/components/schemas/OptionSymbol' text/xml: schema: $ref: '#/components/schemas/OptionSymbol' text/csv: schema: $ref: '#/components/schemas/OptionSymbol' /xGlobalOptions/GetExtendedEquityOption: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: Type in: query schema: allOf: - $ref: '#/components/schemas/OptionTypes' - name: Month in: query schema: type: integer format: int32 - name: Year in: query schema: type: integer format: int32 - name: StrikePrice in: query schema: type: number format: double - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedOption' text/json: schema: $ref: '#/components/schemas/ExtendedOption' application/xml: schema: $ref: '#/components/schemas/ExtendedOption' text/xml: schema: $ref: '#/components/schemas/ExtendedOption' text/csv: schema: $ref: '#/components/schemas/ExtendedOption' /xGlobalOptions/GetExtendedEquityOptionBySymbol: get: tags: - XigniteGlobalOptions parameters: - name: Symbol in: query schema: type: string - name: SymbologyType in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedOption' text/json: schema: $ref: '#/components/schemas/ExtendedOption' application/xml: schema: $ref: '#/components/schemas/ExtendedOption' text/xml: schema: $ref: '#/components/schemas/ExtendedOption' text/csv: schema: $ref: '#/components/schemas/ExtendedOption' /xGlobalOptions/GetExtendedEquityOptionBySymbols: get: tags: - XigniteGlobalOptions parameters: - name: Symbols in: query schema: type: string - name: SymbologyType in: query schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ExtendedOption' text/json: schema: type: array items: $ref: '#/components/schemas/ExtendedOption' application/xml: schema: type: array items: $ref: '#/components/schemas/ExtendedOption' text/xml: schema: type: array items: $ref: '#/components/schemas/ExtendedOption' text/csv: schema: type: array items: $ref: '#/components/schemas/ExtendedOption' /xGlobalOptions/GetExtendedEquityOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: allOf: - $ref: '#/components/schemas/IdentifierTypes' - name: Month in: query schema: type: integer format: int32 - name: Year in: query schema: type: integer format: int32 - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedOptions' text/json: schema: $ref: '#/components/schemas/ExtendedOptions' application/xml: schema: $ref: '#/components/schemas/ExtendedOptions' text/xml: schema: $ref: '#/components/schemas/ExtendedOptions' text/csv: schema: $ref: '#/components/schemas/ExtendedOptions' /xGlobalOptions/GetExtendedOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: type: string - name: ExpirationDate in: query schema: type: string - name: CallPutType in: query schema: type: string - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedOptionChain' text/json: schema: $ref: '#/components/schemas/ExtendedOptionChain' application/xml: schema: $ref: '#/components/schemas/ExtendedOptionChain' text/xml: schema: $ref: '#/components/schemas/ExtendedOptionChain' text/csv: schema: $ref: '#/components/schemas/ExtendedOptionChain' /xGlobalOptions/GetOptionChain: get: tags: - XigniteGlobalOptions parameters: - name: Identifier in: query schema: type: string - name: IdentifierType in: query schema: type: string - name: ExpirationDate in: query schema: type: string - name: CallPutType in: query schema: type: string - name: SymbologyType in: query schema: type: string - name: OptionExchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptionChain' text/json: schema: $ref: '#/components/schemas/OptionChain' application/xml: schema: $ref: '#/components/schemas/OptionChain' text/xml: schema: $ref: '#/components/schemas/OptionChain' text/csv: schema: $ref: '#/components/schemas/OptionChain' /xGlobalOptions/ListUnderlyingSymbols: get: tags: - XigniteGlobalOptions parameters: - name: Exchange in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UnderlyingSymbolList' text/json: schema: $ref: '#/components/schemas/UnderlyingSymbolList' application/xml: schema: $ref: '#/components/schemas/UnderlyingSymbolList' text/xml: schema: $ref: '#/components/schemas/UnderlyingSymbolList' text/csv: schema: $ref: '#/components/schemas/UnderlyingSymbolList' /xGlobalOptions/GetChartBars: get: tags: - XigniteGlobalOptions parameters: - name: Symbol in: query schema: type: string - name: SymbologyType 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: IncludeExtended in: query schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptionChartBars' text/json: schema: $ref: '#/components/schemas/OptionChartBars' application/xml: schema: $ref: '#/components/schemas/OptionChartBars' text/xml: schema: $ref: '#/components/schemas/OptionChartBars' text/csv: schema: $ref: '#/components/schemas/OptionChartBars' components: schemas: Greeks: type: object properties: Delta: type: number format: double Gamma: type: number format: double Theta: type: number format: double Vega: type: number format: double Rho: type: number format: double ImpliedVolatility: type: number format: double OptionPriceTime: type: string nullable: true CalculationTime: type: string nullable: true additionalProperties: false OptionChain: allOf: - $ref: '#/components/schemas/Common' - type: object properties: ExpirationDate: type: string nullable: true Quote: allOf: - $ref: '#/components/schemas/QuickQuote' nullable: true Calls: type: array items: $ref: '#/components/schemas/Option' nullable: true Puts: type: array items: $ref: '#/components/schemas/Option' nullable: true Security: allOf: - $ref: '#/components/schemas/Security' nullable: true additionalProperties: false Option: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Symbol: type: string nullable: true SymbologyType: type: string nullable: true BaseSymbol: type: string nullable: true Type: allOf: - $ref: '#/components/schemas/OptionTypes' ExpirationDate: type: string nullable: true Month: type: integer format: int32 Year: type: integer format: int32 StrikePrice: type: number format: double Currency: type: string nullable: true Date: type: string nullable: true Time: type: string nullable: true Last: type: number format: double LastSize: type: number format: double Open: type: number format: double Close: type: number format: double High: type: number format: double Low: type: number format: double Volume: type: number format: double OpenInterest: type: number format: double OpenInterestDate: type: string nullable: true PreviousClose: type: number format: double PreviousCloseDate: type: string nullable: true Change: type: number format: double PercentChange: type: number format: double Bid: type: number format: double BidDate: type: string nullable: true BidTime: type: string nullable: true BidSize: type: number format: double Ask: type: number format: double AskDate: type: string nullable: true AskTime: type: string nullable: true AskSize: type: number format: double InTheMoney: type: boolean Exchange: type: string nullable: true 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 OptionSymbol: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Symbol: type: string nullable: true SymbologyType: type: string nullable: true BaseSymbol: type: string nullable: true Type: allOf: - $ref: '#/components/schemas/OptionTypes' ExpirationDate: type: string nullable: true Month: type: integer format: int32 Year: type: integer format: int32 StrikePrice: type: number format: double additionalProperties: false OptionChartBars: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Symbol: type: string nullable: true SymbologyType: type: string nullable: true BaseSymbol: type: string nullable: true Type: allOf: - $ref: '#/components/schemas/OptionTypes' ExpirationDate: type: string nullable: true StrikePrice: type: number format: double Currency: type: string nullable: true ContractSize: type: number format: double CFI: type: string nullable: true Exchange: type: string nullable: true Timing: type: string nullable: true ChartBars: type: array items: $ref: '#/components/schemas/ChartBar' nullable: true additionalProperties: false OptionsBaseOfExtendedExpirationExtendedOption: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Security: allOf: - $ref: '#/components/schemas/Security' nullable: true additionalProperties: false OutcomeTypes: enum: - Success - SystemError - RequestError - RegistrationError type: string GreeksByExpiration: type: object properties: ExpirationDate: type: string nullable: true CallOptionGreeks: type: array items: $ref: '#/components/schemas/OptionGreeks' nullable: true PutOptionGreeks: type: array items: $ref: '#/components/schemas/OptionGreeks' nullable: true additionalProperties: false OptionSummary: type: object properties: BaseSymbol: type: string nullable: true Type: type: string nullable: true StrikePrice: type: number format: double ExpirationDate: type: string nullable: true additionalProperties: false Options: allOf: - $ref: '#/components/schemas/OptionsBaseOfExpirationOption' - type: object 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: allOf: - $ref: '#/components/schemas/Common' - 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 OptionsBaseOfExpirationOption: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Security: allOf: - $ref: '#/components/schemas/Security' nullable: true additionalProperties: false ExtendedOptions: allOf: - $ref: '#/components/schemas/OptionsBaseOfExtendedExpirationExtendedOption' - type: object additionalProperties: false UnderlyingSecurity: type: object properties: Symbol: type: string nullable: true Name: type: string nullable: true Currency: type: string nullable: true Exchange: type: string nullable: true additionalProperties: false OptionGreeks: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Symbol: type: string nullable: true Exchange: type: string nullable: true SymbologyType: type: string nullable: true OptionSummary: allOf: - $ref: '#/components/schemas/OptionSummary' nullable: true Greeks: allOf: - $ref: '#/components/schemas/Greeks' nullable: true additionalProperties: false ExtendedOptionChain: allOf: - $ref: '#/components/schemas/Common' - type: object properties: ExpirationDate: type: string nullable: true Quote: allOf: - $ref: '#/components/schemas/QuickQuote' nullable: true Calls: type: array items: $ref: '#/components/schemas/ExtendedOption' nullable: true Puts: type: array items: $ref: '#/components/schemas/ExtendedOption' nullable: true Security: allOf: - $ref: '#/components/schemas/Security' nullable: true additionalProperties: false NumericResult: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Value: type: number format: double additionalProperties: false OptionGreeksByChain: allOf: - $ref: '#/components/schemas/Common' - type: object properties: GreeksByExpirations: type: array items: $ref: '#/components/schemas/GreeksByExpiration' nullable: true Security: allOf: - $ref: '#/components/schemas/Security' nullable: true additionalProperties: false OptionTypes: enum: - Call - Put type: string UnderlyingSymbolList: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Exchange: allOf: - $ref: '#/components/schemas/ExchangeDescription' nullable: true UnderlyingSecurityDescriptions: type: array items: $ref: '#/components/schemas/UnderlyingSecurity' nullable: true additionalProperties: false ExchangeDescription: type: object properties: MarketIdentificationCode: type: string nullable: true Market: type: string nullable: true additionalProperties: false ExtendedOption: allOf: - $ref: '#/components/schemas/Option' - type: object properties: CFI: type: string nullable: true QuoteType: type: string nullable: true ContractSize: type: number format: double Multiplier: type: number format: double DelayedMinutes: type: integer format: int32 UTCLastDate: type: string nullable: true UTCLastTime: type: string nullable: true UTCBidDate: type: string nullable: true UTCBidTime: type: string nullable: true UTCAskDate: type: string nullable: true UTCAskTime: type: string nullable: true LastPriceStyle: type: string nullable: true OpenStyle: type: string nullable: true CloseStyle: type: string nullable: true HighStyle: type: string nullable: true LowStyle: type: string nullable: true VolumeStyle: type: string nullable: true AskStyle: type: string nullable: true BidStyle: type: string nullable: true Mid: type: number format: double MidDate: type: string nullable: true MidTime: type: string nullable: true MidStyle: type: string nullable: true Valuation: type: number format: double ValuationDate: type: string nullable: true ValuationTime: type: string nullable: true ValuationType: type: string nullable: true ValuationStyle: type: string nullable: true UnderlyingSpot: type: number format: double UnderlyingSpotDate: type: string nullable: true PreviousDayLast: type: number format: double PreviousDayLastDate: type: string nullable: true PreviousDayLastTime: type: string nullable: true PreviousDayLastPriceStyle: type: string nullable: true PreviousDayLastSize: type: number format: double PreviousDayValuation: type: number format: double PreviousDayValuationDate: type: string nullable: true PreviousDayValuationTime: type: string nullable: true PreviousDayValuationStyle: type: string nullable: true PreviousDayAsk: type: number format: double PreviousDayAskDate: type: string nullable: true PreviousDayAskTime: type: string nullable: true PreviousDayAskStyle: type: string nullable: true PreviousDayBid: type: number format: double PreviousDayBidDate: type: string nullable: true PreviousDayBidTime: type: string nullable: true PreviousDayBidStyle: type: string nullable: true PreviousDayMid: type: number format: double PreviousDayMidDate: type: string nullable: true PreviousDayMidStyle: type: string nullable: true additionalProperties: false IdentifierTypes: enum: - Symbol - CIK - CUSIP - ISIN - Valoren - SEDOL - FIGI - CompositeFIGI type: string QuickQuote: allOf: - $ref: '#/components/schemas/Common' - type: object properties: Symbol: type: string nullable: true Date: type: string nullable: true Time: type: string nullable: true UTCDate: type: string nullable: true UTCTime: type: string nullable: true Last: type: number format: double Volume: type: number format: double Change: type: number format: double Currency: type: string nullable: true Exchange: type: string nullable: true additionalProperties: false securitySchemes: basic: type: apiKey description: Token for your account. name: _token in: query