Files
OpenBB/website/content/platform/reference/fa/earning.md
Henrique Joaquim 2d8c35df7a Data Models disposition on the website (#5538)
* pydantic v4

* flat structure

* md files

* Revert "md files"

This reverts commit bd2170e2ad.

* improve command descriptions

* nice title and description

* human readble data model names on left panel

* implementation details section

* content markdown files

* markdown versioned files

* showcase page

* updates

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-10-12 18:57:22 +02:00

1.9 KiB
Vendored

title, description
title description
earning OpenBB Platform Function

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

earning

Earnings Calendar. Earnings calendar for a given company.

earning(symbol: Union[str, List[str]], limit: int = 50, provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
limit int The number of data entries to return. 50 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[EarningsCalendar]
        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.
eps float EPS of the earnings calendar.
eps_estimated float Estimated EPS of the earnings calendar.
time str Time of the earnings calendar.
revenue float Revenue of the earnings calendar.
revenue_estimated float Estimated revenue of the earnings calendar.
updated_from_date date Updated from date of the earnings calendar.
fiscal_date_ending date Fiscal date ending of the earnings calendar.