Files
OpenBB/website/content/platform/reference/fa/revgeo.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.9 KiB
Vendored

title, description
title description
revgeo OpenBB Platform Function

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

revgeo

Revenue Geographic.

revgeo(symbol: Union[str, List[str]], period: Literal[str] = annual, structure: Literal[str] = flat, provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
period Literal['quarter', 'annual'] 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

Returns

OBBject
    results : List[RevenueGeographic]
        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
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 the American segment.
europe int Revenue from the the European segment.
greater_china int Revenue from the the Greater China segment.
japan int Revenue from the the Japan segment.
rest_of_asia_pacific int Revenue from the the Rest of Asia Pacific segment.