Eia Coal By Mine By Plant
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaCoalByMineByPlant | EiaCoalByMineByPlantQueryParams | EiaCoalByMineByPlantData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaCoalByMineByPlantData,
EiaCoalByMineByPlantQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'annual'.
data_type: str | None | list[str | None]
Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.
Choices
- ash_content
- heat_content
- price
- quantity
- sulfur_content
coal_rank: str | None | list[str | None]
Coal Type filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all
- anthracite
- bituminous
- lignite
- subbituminous
- synfuel_coal
- waste_coal
coal_supplier: str | None | list[str | None]
Coal Supplier filter. Accepts a comma-separated list of values. Use the facet_options endpoint for the valid values. Multiple items allowed.
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_state: str | None | list[str | None]
Mine State\Region 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
- west_virginia_northern
- west_virginia_southern
- wyoming
plant: str | None | list[str | None]
Plant filter. Accepts a comma-separated list of values. There are 475 valid values - use the facet_options endpoint to list them. Multiple items allowed.
plant_state: str | None | list[str | None]
Plant State\Region filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alabama
- alaska
- arizona
- arkansas
- california
- colorado
- connecticut
- delaware
- florida
- georgia
- hawaii
- illinois
- indiana
- iowa
- kansas
- kentucky
- louisiana
- maine
- maryland
- massachusetts
- michigan
- minnesota
- mississippi
- missouri
- montana
- nebraska
- nevada
- new_hampshire
- new_jersey
- new_mexico
- new_york
- north_carolina
- north_dakota
- ohio
- oklahoma
- oregon
- pennsylvania
- south_carolina
- south_dakota
- tennessee
- texas
- utah
- virginia
- washington
- west_virginia
- wisconsin
- 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
coal_rank: str | None
Coal Type code.
coal_rank_name: str | None
Coal Type name.
coal_supplier: str | None
Coal Supplier code.
coal_supplier_name: str | None
Coal Supplier name.
mine: str | None
Mine code.
mine_name: str | None
Mine name.
mine_state: str | None
Mine State\Region code.
mine_state_name: str | None
Mine State\Region name.
plant: str | None
Plant code.
plant_name: str | None
Plant name.
plant_state: str | None
Plant State\Region code.
plant_state_name: str | None
Plant State\Region name.
ash_content: float | None
Ash content (percent by weight). Withheld or unavailable values return as null.
heat_content: float | None
Heat content (Btu per pound). Withheld or unavailable values return as null.
price: float | None
Price (average dollars per ton). Withheld or unavailable values return as null.
quantity: float | None
Quantity (tons). Withheld or unavailable values return as null.
sulfur_content: float | None
Sulfur content (percent by weight). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.