Files
OpenBB/website/content/platform/data_models/EquityFTD.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774)
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

2.2 KiB
Vendored

title, description
title description
Get reported Fail-to-deliver (FTD) data OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';


Implementation details

Class names

Model name Parameters class Data class
EquityFTD EquityFTDQueryParams EquityFTDData

Import Statement

from openbb_core.provider.standard_models. import (
EquityFTDData,
EquityFTDQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
provider Literal['sec'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. sec True
Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
provider Literal['sec'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. sec True
limit int
Limit the number of reports to parse, from most recent.
Approximately 24 reports per year, going back to 2009.
24 True
skip_reports int
Skip N number of reports from current. A value of 1 will skip the most recent report.
0 True

Data

Name Type Description
settlement_date date The settlement date of the fail.
symbol str Symbol representing the entity requested in the data.
cusip str CUSIP of the Security.
quantity int The number of fails on that settlement date.
price float The price at the previous closing price from the settlement date.
description str The description of the Security.