Eia Petroleum Movements Of Crude Oil And Selected Products By Rail
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRail | EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRailQueryParams | EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRailData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRailData,
EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRailQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- asphalt_and_road_oil
- biodiesel
- crude_oil
- fuel_ethanol
- isobutane
- normal_butane
- petroleum_coke_marketable
- propane
- propylene
- renewable_diesel_fuel
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- can
- na
- padd_1
- padd_2
- padd_3
- padd_4
- padd_5
- us
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. There are 399 valid values - use the facet_options endpoint to list them. Multiple items allowed.
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
process: str | None
Process code.
process_name: str | None
Process name.
product: str | None
Product code.
product_name: str | None
Product name.
region: str | None
DuoArea code.
region_name: str | None
DuoArea name.
series: str | None
Series code.
series_name: str | None
Series name.
value: float | None
Value. Withheld or unavailable values return as null.
units: str | None
Unit of the value.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.