mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
83 lines
2.3 KiB
Markdown
Vendored
83 lines
2.3 KiB
Markdown
Vendored
---
|
|
title: ftd
|
|
description: OpenBB SDK Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# ftd
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Display fails-to-deliver data for a given ticker. [Source: SEC]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/sec_model.py#L60)]
|
|
|
|
```python
|
|
openbb.stocks.dps.ftd(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, limit: int = 0)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Stock ticker | None | False |
|
|
| start_date | Optional[str] | Start of data, in YYYY-MM-DD format | None | True |
|
|
| end_date | Optional[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 |
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display fails-to-deliver data for a given ticker. [Source: SEC]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/sec_view.py#L28)]
|
|
|
|
```python
|
|
openbb.stocks.dps.ftd_chart(symbol: str, data: pd.DataFrame = None, start_date: Optional[str] = None, end_date: Optional[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 | Optional[str] | Start of data, in YYYY-MM-DD format | None | True |
|
|
| end_date | Optional[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
|
|
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
</Tabs> |