Commodity Spot Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CommoditySpotPrices | CommoditySpotPricesQueryParams | CommoditySpotPricesData |
Import Statement
from openbb_core.provider.standard_models.commodity_spot_prices import (
CommoditySpotPricesData,
CommoditySpotPricesQueryParams,
)
Parameters
- standard
- fred
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
commodity: Literal['wti', 'brent', 'natural_gas', 'jet_fuel', 'propane', 'heating_oil', 'diesel_gulf_coast', 'diesel_ny_harbor', 'diesel_la', 'gasoline_ny_harbor', 'gasoline_gulf_coast', 'rbob', 'all']
Commodity name associated with the EIA spot price commodity data, default is 'all'.
• Default: all
• Optional: True
frequency: Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']
Description
Frequency aggregation to convert high frequency data to lower frequency.
None = No change
a = Annual
q = Quarterly
m = Monthly
w = Weekly
d = Daily
wef = Weekly, Ending Friday
weth = Weekly, Ending Thursday
wew = Weekly, Ending Wednesday
wetu = Weekly, Ending Tuesday
wem = Weekly, Ending Monday
wesu = Weekly, Ending Sunday
wesa = Weekly, Ending Saturday
bwew = Biweekly, Ending Wednesday
bwem = Biweekly, Ending Monday
• Optional: True
aggregation_method: Literal['avg', 'sum', 'eop']
Description
A key that indicates the aggregation method used for frequency aggregation.
This parameter has no affect if the frequency parameter is not set.
avg = Average
sum = Sum
eop = End of Period
• Default: eop
• Optional: True
transform: Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']
Description
Transformation type
None = No transformation
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
log = Natural Log
• Optional: True
Data
- standard
- fred
date: Union[date, str]
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
commodity: str
Commodity name.
price: float
Price of the commodity.
unit: str
Unit of the commodity price.
date: Union[date, str]
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
commodity: str
Commodity name.
price: float
Price of the commodity.
unit: str
Unit of the commodity price.