mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 06:22:18 +00:00
4400cd9a8f
* 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>
3.0 KiB
Vendored
3.0 KiB
Vendored
title, description
| title | description |
|---|---|
| Get the most-recent filings submitted to the SEC | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
DiscoveryFilings |
DiscoveryFilingsQueryParams |
DiscoveryFilingsData |
Import Statement
from openbb_core.provider.standard_models. import (
DiscoveryFilingsData,
DiscoveryFilingsQueryParams,
)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| form_type | str | Fuzzy filter by form type. E.g. 10-K, 10, 8, 6-K, etc. | None | True |
| limit | int | The number of data entries to return. | 100 | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| form_type | str | Fuzzy filter by form type. E.g. 10-K, 10, 8, 6-K, etc. | None | True |
| limit | int | The number of data entries to return. | 100 | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| is_done | Literal['true', 'false'] | Flag for whether or not the filing is done. | None | True |
Data
| Name | Type | Description |
|---|---|---|
| timestamp | datetime | The timestamp from when the filing was accepted. |
| symbol | str | Symbol representing the entity requested in the data. |
| cik | str | The CIK of the filing |
| title | str | The title of the filing |
| form_type | str | The form type of the filing |
| url | str | The URL of the filing |
| Name | Type | Description |
|---|---|---|
| timestamp | datetime | The timestamp from when the filing was accepted. |
| symbol | str | Symbol representing the entity requested in the data. |
| cik | str | The CIK of the filing |
| title | str | The title of the filing |
| form_type | str | The form type of the filing |
| url | str | The URL of the filing |
| is_done | Literal['True', 'False'] | Whether or not the filing is done. |