mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
77 lines
2.6 KiB
Markdown
Vendored
77 lines
2.6 KiB
Markdown
Vendored
---
|
|
title: Historical Analyst Estimates
|
|
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 |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `AnalystEstimates` | `AnalystEstimatesQueryParams` | `AnalystEstimatesData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.analyst_estimates import (
|
|
AnalystEstimatesData,
|
|
AnalystEstimatesQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True |
|
|
| limit | int | The number of data entries to return. | 30 | 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>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| date | date | The date of the data. |
|
|
| estimated_revenue_low | int | Estimated revenue low. |
|
|
| estimated_revenue_high | int | Estimated revenue high. |
|
|
| estimated_revenue_avg | int | Estimated revenue average. |
|
|
| estimated_ebitda_low | int | Estimated EBITDA low. |
|
|
| estimated_ebitda_high | int | Estimated EBITDA high. |
|
|
| estimated_ebitda_avg | int | Estimated EBITDA average. |
|
|
| estimated_ebit_low | int | Estimated EBIT low. |
|
|
| estimated_ebit_high | int | Estimated EBIT high. |
|
|
| estimated_ebit_avg | int | Estimated EBIT average. |
|
|
| estimated_net_income_low | int | Estimated net income low. |
|
|
| estimated_net_income_high | int | Estimated net income high. |
|
|
| estimated_net_income_avg | int | Estimated net income average. |
|
|
| estimated_sga_expense_low | int | Estimated SGA expense low. |
|
|
| estimated_sga_expense_high | int | Estimated SGA expense high. |
|
|
| estimated_sga_expense_avg | int | Estimated SGA expense average. |
|
|
| estimated_eps_avg | float | Estimated EPS average. |
|
|
| estimated_eps_high | float | Estimated EPS high. |
|
|
| estimated_eps_low | float | Estimated EPS low. |
|
|
| number_analyst_estimated_revenue | int | Number of analysts who estimated revenue. |
|
|
| number_analysts_estimated_eps | int | Number of analysts who estimated EPS. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|