summaryrefslogtreecommitdiffstats
path: root/website/content/platform/data_models/HistoricalDividends.md
diff options
context:
space:
mode:
Diffstat (limited to 'website/content/platform/data_models/HistoricalDividends.md')
-rw-r--r--website/content/platform/data_models/HistoricalDividends.md59
1 files changed, 0 insertions, 59 deletions
diff --git a/website/content/platform/data_models/HistoricalDividends.md b/website/content/platform/data_models/HistoricalDividends.md
deleted file mode 100644
index 7ecf63db912..00000000000
--- a/website/content/platform/data_models/HistoricalDividends.md
+++ /dev/null
@@ -1,59 +0,0 @@
----
-title: Historical Dividends
-description: OpenBB Platform Data Model
----
-
-<!-- markdownlint-disable MD012 MD031 MD033 -->
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
----
-
-## Implementation details
-
-### Class names
-
-| Model name | Parameters class | Data class |
-| ---------- | ---------------- | ---------- |
-| `HistoricalDividends` | `HistoricalDividendsQueryParams` | `HistoricalDividendsData` |
-
-### Import Statement
-
-```python
-from openbb_core.provider.standard_models.historical_dividends import (
-HistoricalDividendsData,
-HistoricalDividendsQueryParams,
-)
-```
-
-## Parameters
-
-<Tabs>
-<TabItem value="standard" label="Standard">
-
-| Name | Type | Description | Default | Optional |
-| ---- | ---- | ----------- | ------- | -------- |
-| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
-| 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 |
-</TabItem>
-
-</Tabs>
-
-## Data
-
-<Tabs>
-<TabItem value="standard" label="Standard">
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| date | date | The date of the data. |
-| label | str | Label of the historical dividends. |
-| adj_dividend | float | Adjusted dividend of the historical dividends. |
-| dividend | float | Dividend of the historical dividends. |
-| record_date | date | Record date of the historical dividends. |
-| payment_date | date | Payment date of the historical dividends. |
-| declaration_date | date | Declaration date of the historical dividends. |
-</TabItem>
-
-</Tabs>