mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 15:32:04 +00:00
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
3.1 KiB
Vendored
3.1 KiB
Vendored
title, description
| title | description |
|---|---|
| info | OpenBB Platform Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
info
Get general price and performance metrics of a stock.
info(symbol: Union[str, List[str]], provider: Literal[str] = cboe)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. | False | |
| provider | Literal['cboe'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True |
Returns
OBBject
results : List[StockInfo]
Serializable results.
provider : Optional[Literal['cboe']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
metadata: Optional[Metadata]
Metadata info about the command execution.
Data
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol to get data for. |
| name | str | Name associated with the ticker symbol. |
| price | float | Last transaction price. |
| open | float | Opening price of the stock. |
| high | float | High price of the current trading day. |
| low | float | Low price of the current trading day. |
| close | float | Closing price of the most recent trading day. |
| change | float | Change in price over the current trading period. |
| change_percent | float | Percent change in price over the current trading period. |
| prev_close | float | Previous closing price. |
| Name | Type | Description |
|---|---|---|
| type | str | Type of asset. |
| exchange_id | int | The Exchange ID number. |
| tick | str | Whether the last sale was an up or down tick. |
| bid | float | Current bid price. |
| bid_size | float | Bid lot size. |
| ask | float | Current ask price. |
| ask_size | float | Ask lot size. |
| volume | float | Stock volume for the current trading day. |
| iv30 | float | The 30-day implied volatility of the stock. |
| iv30_change | float | Change in 30-day implied volatility of the stock. |
| last_trade_timestamp | datetime | Last trade timestamp for the stock. |
| iv30_annual_high | float | The 1-year high of implied volatility. |
| hv30_annual_high | float | The 1-year high of realized volatility. |
| iv30_annual_low | float | The 1-year low of implied volatility. |
| hv30_annual_low | float | The 1-year low of realized volatility. |
| iv60_annual_high | float | The 60-day high of implied volatility. |
| hv60_annual_high | float | The 60-day high of realized volatility. |
| iv60_annual_low | float | The 60-day low of implied volatility. |
| hv60_annual_low | float | The 60-day low of realized volatility. |
| iv90_annual_high | float | The 90-day high of implied volatility. |
| hv90_annual_high | float | The 90-day high of realized volatility. |