Eia Coal Mine Aggregates

---

Implementation details

Class names

Model name	Parameters class	Data class
EiaCoalMineAggregates	EiaCoalMineAggregatesQueryParams	EiaCoalMineAggregatesData

Import Statement

from openbb_core.provider.standard_models. import (
EiaCoalMineAggregatesData,
EiaCoalMineAggregatesQueryParams,
)

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 Rank filter. Accepts a comma-separated list of values. Multiple items allowed.

Choices

• all
• anthracite
• bituminous
• lignite
• 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_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

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 Rank code.

coal_rank_name: str | None
Coal Rank 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.

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.