Files
OpenBB/website/content/platform/reference/fa/emp.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.8 KiB
Vendored

title, description
title description
emp OpenBB Platform Function

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

emp

Historical Employees. Historical number of employees.

emp(symbol: Union[str, List[str]], provider: Literal[str] = fmp)

Parameters

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

Returns

OBBject
    results : List[HistoricalEmployees]
        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.
cik int CIK of the company to retrieve the historical employees of.
acceptance_time datetime Time of acceptance of the company employee.
period_of_report date Date of reporting of the company employee.
company_name str Registered name of the company to retrieve the historical employees of.
form_type str Form type of the company employee.
filing_date date Filing date of the company employee
employee_count int Count of employees of the company.
source str Source URL which retrieves this data for the company.