Fred Commodity Spot Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FredCommoditySpotPrices | FredCommoditySpotPricesQueryParams | FredCommoditySpotPricesData |
Import Statement
from openbb_core.provider.standard_models. import (
FredCommoditySpotPricesData,
FredCommoditySpotPricesQueryParams,
)
Parameters
- standard
- fred
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.
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.
commodity: str | None
Default: all
Commodity name associated with the EIA spot price commodity data, default is 'all'.
Choices
- 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
frequency: str | None
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
Choices
- a
- q
- m
- w
- d
- wef
- weth
- wew
- wetu
- wem
- wesu
- wesa
- bwew
- bwem
aggregation_method: str | None
Default: 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
Choices
- avg
- sum
- eop
transform: str | None
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
Choices
- chg
- ch1
- pch
- pc1
- pca
- cch
- cca
- log
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
Data
- standard
- fred
date: date | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
commodity: str | None
Commodity name.
price: float
Price of the commodity.
unit: str | None
Unit of the commodity price.
date: date | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
commodity: str | None
Commodity name.
price: float
Price of the commodity.
unit: str | None
Unit of the commodity price.