mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 22:41:19 +00:00
* fix typo * fix typos * fix typo * fix typos * fix typos * fix typos * fix typo --------- Co-authored-by: Luqman <luqazino@gmail.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
1.8 KiB
Vendored
1.8 KiB
Vendored
title, description
| title | description |
|---|---|
| Revenue Geographic | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
RevenueGeographic |
RevenueGeographicQueryParams |
RevenueGeographicData |
Import Statement
from openbb_core.provider.standard_models.revenue_geographic import (
RevenueGeographicData,
RevenueGeographicQueryParams,
)
Parameters
| 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 |
| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 |
Data
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| geographic_segment | Dict[str, int] | Day level data containing the revenue of the geographic segment. |
| americas | int | Revenue from the American segment. |
| europe | int | Revenue from the European segment. |
| greater_china | int | Revenue from the Greater China segment. |
| japan | int | Revenue from the Japan segment. |
| rest_of_asia_pacific | int | Revenue from the Rest of Asia Pacific segment. |