international
International energy production, consumption, and trade statistics by country and region.
Examples
from openbb import obb
# Annual petroleum production for OPEC members.
obb.eia.international(provider='eia', product='total_petroleum_and_other_liquids', activity='production', country='opec', limit=100)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
activity: str | None | list[str | None]
Activity filter. Multiple items allowed.
Choices
- consumption
- imports
- production
- stocks_oecd
country: str | None | list[str | None]
Country/Region filter. Accepts a comma-separated list of values. There are 268 valid values - use the facet_options endpoint to list them. Multiple items allowed.
country_type: str | None | list[str | None]
Country/Region Type filter. Multiple items allowed.
Choices
- country
- region
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- canada_imports_by_source
- crude_oil_including_lease_condensate
- crude_oil_ngpl_and_other_liquids
- france_imports_by_source
- germany_imports_by_source
- italy_imports_by_source
- japan_imports_by_source
- ngpl
- oecd_europe_imports_by_source
- oecd_imports
- other_liquids
- petroleum_and_other_liquids
- refined_petroleum_products
- refinery_processing_gain
- south_korea_imports_by_source
- total_petroleum_and_other_liquids
- us_imports_by_source
- united_kingdom_imports_by_source
unit: str | None | list[str | None]
Unit filter. Multiple items allowed.
Choices
- 1000_metric_tons
- millions_barrels
- thousand_barrels_per_day
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
sort: str | None
Default: asc
Sort the results by date.
limit: int | None
Maximum number of rows to return. The default returns all rows, paginating requests as needed.
Returns
results: EiaInternational
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- eia
activity: str | None
Activity code.
activity_name: str | None
Activity name.
country: str | None
Country/Region code.
country_name: str | None
Country/Region name.
country_type: str | None
Country/Region Type code.
country_type_name: str | None
Country/Region Type name.
data_flag: str | None
Data flag ID code.
data_flag_name: str | None
Data flag ID name.
product: str | None
Product code.
product_name: str | None
Product name.
unit: str | None
Unit code.
unit_name: str | None
Unit name.
value: float | None
Value. Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.