Cboe Equity Quote
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CboeEquityQuote | CboeEquityQuoteQueryParams | CboeEquityQuoteData |
Import Statement
from openbb_core.provider.standard_models. import (
CboeEquityQuoteData,
CboeEquityQuoteQueryParams,
)
Parameters
- standard
- cboe
symbol: str
Symbol to get data for.
symbol: str
Symbol to get data for.
use_cache: bool | None
Default: True
When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.
Data
- standard
- cboe
symbol: str
Symbol representing the entity requested in the data.
asset_type: str | None
Type of asset - i.e, stock, ETF, etc.
name: str | None
Name of the company or asset.
exchange: str | None
The name or symbol of the venue where the data is from.
bid: float | None
Price of the top bid order.
bid_size: int | None
This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.
bid_exchange: str | None
The specific trading venue where the purchase order was placed.
ask: float | None
Price of the top ask order.
ask_size: int | None
This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.
ask_exchange: str | None
The specific trading venue where the sale order was placed.
quote_conditions: int | list[int] | list[str] | str | None
Conditions or condition codes applicable to the quote.
quote_indicators: int | list[int] | list[str] | str | None
Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.
sales_conditions: int | list[int] | list[str] | str | None
Conditions or condition codes applicable to the sale.
sequence_number: int | None
The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
market_center: str | None
The ID of the UTP participant that originated the message.
participant_timestamp: datetime | None
Timestamp for when the quote was generated by the exchange.
trf_timestamp: datetime | None
Timestamp for when the TRF (Trade Reporting Facility) received the message.
sip_timestamp: datetime | None
Timestamp for when the SIP (Security Information Processor) received the message from the exchange.
last_price: float | None
Price of the last trade.
last_tick: str | None
Whether the last sale was an up or down tick.
last_size: int | None
Size of the last trade.
last_timestamp: datetime | None
Date and Time when the last price was recorded.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: float | int | None
The trading volume.
exchange_volume: float | int | None
Volume of shares exchanged during the trading day on the specific exchange.
prev_close: float | None
The previous close price.
change: float | None
Change in price from previous close.
change_percent: float | None
Change in price as a normalized percentage.
year_high: float | None
The one year high (52W High).
year_low: float | None
The one year low (52W Low).
symbol: str
Symbol representing the entity requested in the data.
asset_type: str | None
Type of asset - i.e, stock, ETF, etc.
name: str | None
Name of the company or asset.
exchange: str | None
The name or symbol of the venue where the data is from.
bid: float | None
Price of the top bid order.
bid_size: int | None
This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.
bid_exchange: str | None
The specific trading venue where the purchase order was placed.
ask: float | None
Price of the top ask order.
ask_size: int | None
This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.
ask_exchange: str | None
The specific trading venue where the sale order was placed.
quote_conditions: int | list[int] | list[str] | str | None
Conditions or condition codes applicable to the quote.
quote_indicators: int | list[int] | list[str] | str | None
Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.
sales_conditions: int | list[int] | list[str] | str | None
Conditions or condition codes applicable to the sale.
sequence_number: int | None
The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
market_center: str | None
The ID of the UTP participant that originated the message.
participant_timestamp: datetime | None
Timestamp for when the quote was generated by the exchange.
trf_timestamp: datetime | None
Timestamp for when the TRF (Trade Reporting Facility) received the message.
sip_timestamp: datetime | None
Timestamp for when the SIP (Security Information Processor) received the message from the exchange.
last_price: float | None
Price of the last trade.
last_tick: str | None
Whether the last sale was an up or down tick.
last_size: int | None
Size of the last trade.
last_timestamp: datetime | None
Date and Time when the last price was recorded.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: float | int | None
The trading volume.
exchange_volume: float | int | None
Volume of shares exchanged during the trading day on the specific exchange.
prev_close: float | None
The previous close price.
change: float | None
Change in price from previous close.
change_percent: float | None
Change in price as a normalized percentage.
year_high: float | None
The one year high (52W High).
year_low: float | None
The one year low (52W Low).
iv30: float | None
The 30-day implied volatility of the stock.
iv30_change: float | None
Change in 30-day implied volatility of the stock.
iv30_change_percent: float | None
Change in 30-day implied volatility of the stock as a normalized percentage value.
iv30_annual_high: float | None
The 1-year high of 30-day implied volatility.
hv30_annual_high: float | None
The 1-year high of 30-day realized volatility.
iv30_annual_low: float | None
The 1-year low of 30-day implied volatility.
hv30_annual_low: float | None
The 1-year low of 30-day realized volatility.
iv60_annual_high: float | None
The 1-year high of 60-day implied volatility.
hv60_annual_high: float | None
The 1-year high of 60-day realized volatility.
iv60_annual_low: float | None
The 1-year low of 60-day implied volatility.
hv60_annual_low: float | None
The 1-year low of 60-day realized volatility.
iv90_annual_high: float | None
The 1-year high of 90-day implied volatility.
hv90_annual_high: float | None
The 1-year high of 90-day realized volatility.
iv90_annual_low: float | None
The 1-year low of 90-day implied volatility.
hv90_annual_low: float | None
The 1-year low of 90-day realized volatility.