Eia Coal Exports Imports Quantity Price
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaCoalExportsImportsQuantityPrice | EiaCoalExportsImportsQuantityPriceQueryParams | EiaCoalExportsImportsQuantityPriceData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaCoalExportsImportsQuantityPriceData,
EiaCoalExportsImportsQuantityPriceQueryParams,
)
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: price (dollars per short ton); quantity (short tons). Multiple items allowed.
Choices
- price
- quantity
coal_rank: str | None | list[str | None]
Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all
- coke
- metallurgical
- steam_coal
country: str | None | list[str | None]
Country filter. Accepts a comma-separated list of values. There are 141 valid values - use the facet_options endpoint to list them. Multiple items allowed.
customs_district: str | None | list[str | None]
Customs District filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- anchorage_ak
- baltimore_md
- boston_ma
- buffalo_ny
- charleston_sc
- charlotte_nc
- chicago_il
- cleveland_oh
- columbia_snake_or
- dallas_fort_worth_tx
- detroit_mi
- duluth_mn
- el_paso_tx
- great_falls_mt
- honolulu_hi
- houston_galveston_tx
- laredo_tx
- los_angeles_ca
- miami_fl
- milwaukee_wi
- minneapolis_mn
- mobile_al
- new_orleans_la
- new_york_city_ny
- nogales_az
- norfolk_va
- ogdensburg_ny
- other_ports
- pembina_nd
- philadelphia_pa
- port_arthur_tx
- portland_me
- portland_or
- providence_ri
- san_diego_ca
- san_francisco_ca
- san_juan_pr
- savannah_ga
- seattle_wa
- st_albans_vt
- tampa_fl
- total
- virgin_islands_of_the_united_states
- wilmington_nc
export_import_type: str | None | list[str | None]
Export\Import Type filter. Multiple items allowed.
Choices
- exports
- imports
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.
country: str | None
Country code.
country_name: str | None
Country name.
customs_district: str | None
Customs District code.
customs_district_name: str | None
Customs District name.
export_import_type: str | None
Export\Import Type code.
export_import_type_name: str | None
Export\Import Type name.
price: float | None
Price (dollars per short ton). Withheld or unavailable values return as null.
quantity: float | None
Quantity (short tons). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.