Eia Coal Reserves Capacity
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaCoalReservesCapacity | EiaCoalReservesCapacityQueryParams | EiaCoalReservesCapacityData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaCoalReservesCapacityData,
EiaCoalReservesCapacityQueryParams,
)
Parameters
- standard
- eia
data_type: str | None | list[str | None]
Data column(s) to return, comma-separated. The default returns every column. Choices: producer_distributor_stocks (short tons); productive_capacity (short tons); recoverable_reserves (short tons). Multiple items allowed.
Choices
- producer_distributor_stocks
- productive_capacity
- recoverable_reserves
mine_type: str | None | list[str | None]
Mine Type filter. Multiple items allowed.
Choices
- surface
- total
- underground
state_region: str | None | list[str | None]
State\Region filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alabama
- alaska
- appalachia_central
- appalachia_northern
- appalachia_southern
- appalachia_total
- arizona
- arkansas
- colorado
- east_north_central
- east_south_central
- east_total
- east_of_mississippi_river
- illinois
- illinois_basin
- indiana
- interior_region_total
- kansas
- kentucky
- kentucky_east
- kentucky_west
- louisiana
- maryland
- middle_atlantic
- midwest_total
- mississippi
- missouri
- montana
- mountain
- new_mexico
- north_dakota
- ohio
- oklahoma
- other_interior
- other_western
- pacific_contiguous
- pacific_noncontiguous
- pennsylvania
- pennsylvania_anthracite
- pennsylvania_bituminous
- powder_river_basin
- south_atlantic
- south_total
- tennessee
- texas
- us_total
- uinta_basin
- utah
- virginia
- washington
- west_north_central
- west_south_central
- west_total
- west_virginia
- west_virginia_northern
- west_virginia_southern
- west_of_mississippi_river
- western_region_total
- wyoming
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
mine_type: str | None
Mine Type code.
mine_type_name: str | None
Mine Type name.
state_region: str | None
State\Region code.
state_region_name: str | None
State\Region name.
producer_distributor_stocks: float | None
Producer distributor stocks (short tons). Withheld or unavailable values return as null.
productive_capacity: float | None
Productive capacity (short tons). Withheld or unavailable values return as null.
recoverable_reserves: float | None
Recoverable reserves (short tons). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.