Eia Natural Gas Coalbed Methane
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaNaturalGasCoalbedMethane | EiaNaturalGasCoalbedMethaneQueryParams | EiaNaturalGasCoalbedMethaneData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaNaturalGasCoalbedMethaneData,
EiaNaturalGasCoalbedMethaneQueryParams,
)
Parameters
- standard
- eia
process: str | None | list[str | None]
Process filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- coalbed_methane_proved_reserves
- coalbed_methane_reserves_acquisitions
- coalbed_methane_reserves_adjustments
- coalbed_methane_reserves_based_production
- coalbed_methane_reserves_extensions
- coalbed_methane_reserves_extensions_and_discoveries
- coalbed_methane_reserves_new_field_discoveries
- coalbed_methane_reserves_new_reservoir_discoveries_in_old
- coalbed_methane_reserves_revision_decreases
- coalbed_methane_reserves_revision_increases
- coalbed_methane_reserves_sales
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- california
- colorado
- florida
- na
- new_york
- ohio
- texas
- us
- usa_ak
- usa_al
- usa_ar
- usa_ks
- usa_ky
- usa_la
- usa_mi
- usa_ms
- usa_mt
- usa_nd
- usa_nm
- usa_ok
- usa_pa
- usa_ut
- usa_va
- usa_wv
- usa_wy
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. There are 560 valid values - use the facet_options endpoint to list them. 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.
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.