OpenBB/website/content/platform/reference/fa/cal.md

title, description

title	description
cal	OpenBB Platform Function

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

cal

Show Dividend Calendar for a given start and end dates.

cal(start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fmp)

---

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

---

Returns

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

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.