Eia Coal Consumption And Quality

---

Implementation details

Class names

Model name	Parameters class	Data class
EiaCoalConsumptionAndQuality	EiaCoalConsumptionAndQualityQueryParams	EiaCoalConsumptionAndQualityData

Import Statement

from openbb_core.provider.standard_models. import (
EiaCoalConsumptionAndQualityData,
EiaCoalConsumptionAndQualityQueryParams,
)

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 (average ash percent by weight); consumption (short tons); heat_content (average sulfur percent by weight); price (dollars per short ton); receipts (short tons); stocks (short tons); sulfur_content (average sulfur percent by weight). Multiple items allowed.

Choices

• ash_content
• consumption
• heat_content
• price
• receipts
• stocks
• sulfur_content

sector: str | None | list[str | None]
Sector filter. Accepts a comma-separated list of values. Multiple items allowed.

Choices

• coke_plants
• commercial_and_institutional
• electric_power
• electric_utility
• ipp_chp
• ipp_non_chp
• independent_power_producers
• other_industrial

state_region: str | None | list[str | None]
U.S. Total, States, and Census Regions. filter. Accepts a comma-separated list of values. Multiple items allowed.

Choices

• alabama
• alaska
• arizona
• arkansas
• california
• colorado
• connecticut
• delaware
• district_of_columbia
• east_north_central
• east_south_central
• florida
• georgia
• hawaii
• idaho
• illinois
• indiana
• iowa
• kansas
• kentucky
• louisiana
• maine
• maryland
• massachusetts
• michigan
• middle_atlantic
• minnesota
• mississippi
• missouri
• montana
• mountain
• nebraska
• nevada
• new_england
• new_hampshire
• new_jersey
• new_mexico
• new_york
• north_carolina
• north_dakota
• ohio
• oklahoma
• oregon
• pacific
• pacific_contiguous
• pacific_noncontiguous
• pennsylvania
• puerto_rico
• rhode_island
• south_atlantic
• south_carolina
• south_dakota
• tennessee
• texas
• us_total
• utah
• vermont
• virginia
• washington
• west_north_central
• west_south_central
• 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

sector: str | None
Sector code.

sector_name: str | None
Sector name.

state_region: str | None
U.S. Total, States, and Census Regions. code.

state_region_name: str | None
U.S. Total, States, and Census Regions. name.

ash_content: float | None
Ash content (average ash percent by weight). Withheld or unavailable values return as null.

consumption: float | None
Consumption (short tons). Withheld or unavailable values return as null.

heat_content: float | None
Heat content (average sulfur percent by weight). Withheld or unavailable values return as null.

price: float | None
Price (dollars per short ton). Withheld or unavailable values return as null.

receipts: float | None
Receipts (short tons). Withheld or unavailable values return as null.

stocks: float | None
Stocks (short tons). Withheld or unavailable values return as null.

sulfur_content: float | None
Sulfur content (average sulfur 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.