mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 02:11:44 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
76 lines
1.9 KiB
Markdown
Vendored
76 lines
1.9 KiB
Markdown
Vendored
---
|
|
title: cal
|
|
description: OpenBB Platform Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# cal
|
|
|
|
Show Dividend Calendar for a given start and end dates.
|
|
|
|
```python wordwrap
|
|
cal(start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fmp)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| 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 |
|
|
| 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>
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
```python wordwrap
|
|
OBBject
|
|
results : List[DividendCalendar]
|
|
Serializable results.
|
|
|
|
provider : Optional[Literal['fmp']]
|
|
Provider name.
|
|
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
|
|
metadata: Optional[Metadata]
|
|
Metadata info about the command execution.
|
|
```
|
|
|
|
---
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol to get data for. |
|
|
| date | date | The date of the data. |
|
|
| label | str | Date in human readable form in the calendar. |
|
|
| adj_dividend | NonNegativeFloat | Adjusted dividend on a date in the calendar. |
|
|
| dividend | NonNegativeFloat | Dividend amount in the calendar. |
|
|
| record_date | date | Record date of the dividend in the calendar. |
|
|
| payment_date | date | Payment date of the dividend in the calendar. |
|
|
| declaration_date | date | Declaration date of the dividend in the calendar. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|