natural_gas_summary
Natural Gas Summary. EIA natural gas survey data
Examples
from openbb import obb
obb.eia.natural_gas.summary.natural_gas_summary(provider='eia', limit=100)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
process: str | None | list[str | None]
Process filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- city_gate_price
- commercial_consumption
- delivered_to_consumers
- dry_production
- electric_power_consumption
- electric_power_price
- exports
- exports_price
- extraction_loss
- gross_withdrawals
- imports
- imports_price
- industrial_consumption
- industrial_price
- lng_imports
- lease_and_plant_fuel_consumption
- liquefied_natural_gas_exports
- liquefied_natural_gas_exports_price
- liquefied_natural_gas_imports
- marketed_production
- pipeline_exports
- pipeline_exports_price
- pipeline_fuel_consumption
- pipeline_imports
- pipeline_imports_price
- price_delivered_to_commercial_sectors
- price_delivered_to_residential_consumers
- removed_from_natural_gas
- repressuring
- residential_consumption
- total_consumption
- total_underground_storage
- total_underground_storage_capacity
- underground_storage_base_gas
- underground_storage_injections
- underground_storage_net_withdrawals
- underground_storage_withdrawals
- underground_storage_working_gas
- vehicle_fuel_consumption
- vented_and_flared
- wellhead_acquisition_price
- withdrawals_from_coalbed_wells
- withdrawals_from_gas_wells
- withdrawals_from_oil_wells
- withdrawals_from_shale_gas
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- california
- colorado
- florida
- massachusetts
- minnesota
- na
- new_york
- ohio
- texas
- us
- usa_ak
- usa_al
- usa_ar
- usa_az
- usa_ct
- usa_dc
- usa_de
- usa_ga
- usa_hi
- usa_ia
- usa_id
- usa_il
- usa_in
- usa_ks
- usa_ky
- usa_la
- usa_md
- usa_me
- usa_mi
- usa_mo
- usa_ms
- usa_mt
- usa_nc
- usa_nd
- usa_ne
- usa_nh
- usa_nj
- usa_nm
- usa_nv
- usa_ok
- usa_or
- usa_pa
- usa_ri
- usa_sc
- usa_sd
- usa_tn
- usa_ut
- usa_va
- usa_vt
- usa_wi
- usa_wv
- usa_wy
- washington
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Use the facet_options endpoint for the valid values. Multiple items allowed.
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: EiaNaturalGasNaturalGasSummary
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
process: str | None
Process code.
process_name: str | None
Process name.
product: str | None
Product code.
product_name: str | None
Product name.
region: str | None
DuoArea code.
region_name: str | None
DuoArea name.
series: str | None
Series code.
series_name: str | None
Series name.
value: float | None
Value. Withheld or unavailable values return as null.
units: str | None
Unit of the value.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.