Eia Coal Mine Production
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaCoalMineProduction | EiaCoalMineProductionQueryParams | EiaCoalMineProductionData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaCoalMineProductionData,
EiaCoalMineProductionQueryParams,
)
Parameters
- standard
- eia
data_type: str | None | list[str | None]
Data column(s) to return, comma-separated. The default returns every column. Choices: average_employees (number of employees); labor_hours (hours); latitude; longitude; operating_company; operating_company_address; production (short tons); refuse_flag. Multiple items allowed.
Choices
- average_employees
- labor_hours
- latitude
- longitude
- operating_company
- operating_company_address
- production
- refuse_flag
census_region: str | None | list[str | None]
Census Region filter. Multiple items allowed.
Choices
- east_north_central
- east_south_central
- middle_atlantic
- mountain
- pacific_contiguous
- pacific_noncontiguous
- south_atlantic
- west_north_central
- west_south_central
coal_rank: str | None | list[str | None]
Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- anthracite
- bituminous
- lignite
- preparation_plant
- subbituminous
mine: str | None | list[str | None]
Mine filter. Accepts a comma-separated list of values. Use the facet_options endpoint for the valid values. Multiple items allowed.
mine_county: str | None | list[str | None]
Mine County filter. Accepts a comma-separated list of values. There are 107 valid values - use the facet_options endpoint to list them. Multiple items allowed.
mine_region: str | None | list[str | None]
Region filter. Multiple items allowed.
Choices
- east
- midwest
- south
- west
mine_status: str | None | list[str | None]
Mine Status filter. Multiple items allowed.
Choices
- active
- active_men_not_working_not_producing
- active_men_working_not_producing
- mine_closed_by_msha
- new_under_construction
- permanently_abandoned
- temporarily_closed
mine_type: str | None | list[str | None]
Mine Type filter. Multiple items allowed.
Choices
- refuse
- surface
- underground
mississippi_region: str | None | list[str | None]
Mississippi Region filter. Multiple items allowed.
Choices
- east_of_mississippi_river
- west_of_mississippi_river
state_region: str | None | list[str | None]
State filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alabama
- alaska
- arizona
- arkansas
- colorado
- illinois
- indiana
- kansas
- kentucky_east
- kentucky_west
- louisiana
- maryland
- mississippi
- missouri
- montana
- new_mexico
- north_dakota
- ohio
- oklahoma
- pennsylvania_anthracite
- pennsylvania_bituminous
- tennessee
- texas
- utah
- virginia
- washington
- west_virginia_northern
- west_virginia_southern
- wyoming
supply_region: str | None | list[str | None]
Supply Region filter. Multiple items allowed.
Choices
- appalachia_central
- appalachia_northern
- appalachia_southern
- illinois_basin
- other_interior
- other_western
- powder_river_basin
- uinta_basin
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
census_region: str | None
Census Region code.
census_region_name: str | None
Census Region name.
coal_rank: str | None
Coal Rank code.
coal_rank_name: str | None
Coal Rank name.
mine: str | None
Mine code.
mine_name: str | None
Mine name.
mine_county: str | None
Mine County code.
mine_county_name: str | None
Mine County name.
mine_region: str | None
Region code.
mine_region_name: str | None
Region name.
mine_status: str | None
Mine Status code.
mine_status_name: str | None
Mine Status name.
mine_type: str | None
Mine Type code.
mine_type_name: str | None
Mine Type name.
mississippi_region: str | None
Mississippi Region code.
mississippi_region_name: str | None
Mississippi Region name.
state_region: str | None
State code.
state_region_name: str | None
State name.
supply_region: str | None
Supply Region code.
supply_region_name: str | None
Supply Region name.
average_employees: float | None
Average employees (number of employees). Withheld or unavailable values return as null.
labor_hours: float | None
Labor hours (hours). Withheld or unavailable values return as null.
latitude: float | None
Latitude. Withheld or unavailable values return as null.
longitude: float | None
Longitude. Withheld or unavailable values return as null.
operating_company: str | None
Operating company
operating_company_address: str | None
Operating company address
production: float | None
Production (short tons). Withheld or unavailable values return as null.
refuse_flag: str | None
Refuse flag
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.