Skip to main content
Version: v5

facet_options

List the valid values for one filter (facet) of an EIA dataset.

Examples​

from openbb import obb
# List the spot price series available from the petroleum group.
obb.eia.facet_options(group='petroleum', dataset='spot_prices', facet='series')
# List the balancing authorities of the hourly grid monitor.
obb.eia.facet_options(group='electricity_grid', dataset='demand', facet='respondent')

Parameters​

group: str
facet: str
dataset: str


Returns​

results: Any

Serializable results.

provider: str

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.