Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/stocks/dps/ftd.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

2.3 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: 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

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: 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