Fred Series

---

Implementation details

Class names

Model name	Parameters class	Data class
FredSeries	FredSeriesQueryParams	FredSeriesData

Import Statement

from openbb_core.provider.standard_models. import (
FredSeriesData,
FredSeriesQueryParams,
)

---

Parameters

• standard
• fred
• intrinio

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): fred.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
limit	int	The number of data entries to return.	100000	True
provider	Literal['fred', 'intrinio']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.	fred	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): fred.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
limit	int	The number of data entries to return.	100000	True
provider	Literal['fred', 'intrinio']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.	fred	True
frequency	Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']	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	None	True
aggregation_method	Literal[None, 'avg', 'sum', 'eop']	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	eop	True
transform	Literal[None, 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']	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	None	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): fred.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
limit	int	The number of data entries to return.	100000	True
provider	Literal['fred', 'intrinio']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.	fred	True
all_pages	bool	Returns all pages of data from the API call at once.	False	True
sleep	float	Time to sleep between requests to avoid rate limiting.	1.0	True

---

Data

• standard
• fred
• intrinio

Name	Type	Description
date	date	The date of the data.

Name	Type	Description
date	date	The date of the data.

Name	Type	Description
date	date	The date of the data.
value	float	Value of the index.