mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-06 01:12:27 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
2.2 KiB
Vendored
2.2 KiB
Vendored
title, description
| title | description |
|---|---|
| ftd | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
ftd
Display fails-to-deliver data for a given ticker. [Source: SEC]
Source Code: [link]
openbb.stocks.dps.ftd(symbol: str, start_date: str = None, end_date: str = None, limit: int = 0)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker | None | False |
| start_date | str | Start of data, in YYYY-MM-DD format | None | True |
| end_date | str | End of data, in YYYY-MM-DD format | None | True |
| limit | int | Number of latest fails-to-deliver being printed | 0 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Fail to deliver data |
Display fails-to-deliver data for a given ticker. [Source: SEC]
Source Code: [link]
openbb.stocks.dps.ftd_chart(symbol: str, data: pd.DataFrame = None, start_date: str = None, end_date: str = None, limit: int = 0, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker | None | False |
| data | pd.DataFrame | Stock data | None | True |
| start_date | str | Start of data, in YYYY-MM-DD format | None | True |
| end_date | str | End of data, in YYYY-MM-DD format | None | True |
| limit | int | Number of latest fails-to-deliver being printed | 0 | True |
| raw | bool | Print raw data | False | True |
| export | str | Export dataframe data to csv,json,xlsx file | True | |
| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True |
Returns
This function does not return anything