receipts
Receipts. Coal shipment detailed by reciepient data, including transportation type, supplier, mine, coal basin, county, state, rank, contract type, price, quantity, and quality. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/
Examples
from openbb import obb
obb.eia.coal.receipts(provider='eia', limit=100)
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
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.
contract_type: str | None | list[str | None]
Contract Type filter. Multiple items allowed.
Choices
- contract_purchase
- new_contract
- none
- spot_market_purchase
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_basin: str | None | list[str | None]
Mine Basin filter. Multiple items allowed.
Choices
- appalachia_central
- appalachia_northern
- appalachia_southern
- illinois_basin
- other_interior
- other_western
- powder_river_basin
- uinta_basin
mine_county: str | None | list[str | None]
Mine County filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- 10
- 101
- 107
- 109
- 115
- 119
- 127
- 129
- 133
- 147
- 149
- 159
- 175
- 177
- 189
- 203
- 225
- 233
- 235
- 237
- 25
- 3
- 33
- 39
- 47
- 49
- 53
- 61
- 63
- 67
- 7
- 71
- 77
- 79
- 81
- 85
- 9
- 91
- 95
- 97
- 99
- anderson
- atascosa
- bourbon
- campbell
- choctaw
- clay
- columbiana
- coshocton
- craig
- crawford
- cullman
- daviess
- dickenson
- douglas
- emery
- fayette
- freestone
- gallatin
- jefferson
- lawrence
- lee
- leon
- limestone
- lincoln
- marion
- mclean
- meigs
- montgomery
- natchitoches
- navajo
- noble
- none
- okmulgee
- oliver
- perry
- richland
- rio_blanco
- robertson
- rogers
- rusk
- saline
- san_juan
- shelby
- stark
- sullivan
- tazewell
- titus
- tuscaloosa
- tuscarawas
- vermilion
- vigo
- vinton
- warrick
- white
- williamson
- wise
- yukon_koyukuk
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
mine_type: str | None | list[str | None]
Mine Type filter. Multiple items allowed.
Choices
- surface
- underground
plant: str | None | list[str | None]
Plant filter. Accepts a comma-separated list of values. There are 471 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
transportation_mode: str | None | list[str | None]
Transportation Mode filter. Multiple items allowed.
Choices
- great_lakes
- none
- pipeline
- rail
- river
- tidewater_piers
- tramway_conveyor
- truck
- water
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.
Returns
results: EiaCoalReceipts
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- eia
coal_rank: str | None
Coal Rank code.
coal_rank_name: str | None
Coal Rank name.
coal_supplier: str | None
Coal Supplier code.
coal_supplier_name: str | None
Coal Supplier name.
contract_type: str | None
Contract Type code.
contract_type_name: str | None
Contract Type name.
mine: str | None
Mine code.
mine_name: str | None
Mine name.
mine_basin: str | None
Mine Basin code.
mine_basin_name: str | None
Mine Basin name.
mine_county: str | None
Mine County code.
mine_county_name: str | None
Mine County name.
mine_state: str | None
Mine State\Region code.
mine_state_name: str | None
Mine State\Region name.
mine_type: str | None
Mine Type code.
mine_type_name: str | None
Mine Type 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.
transportation_mode: str | None
Transportation Mode code.
transportation_mode_name: str | None
Transportation Mode 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.