OpenBB/website/content/platform/data_models/FredIndices.md

title, description

title	description
Historical Fred Indices	OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

---

Implementation details

Class names

Model name	Parameters class	Data class
FredIndices	FredIndicesQueryParams	FredIndicesData

Import Statement

from openbb_core.provider.standard_models.fred_indices import (
FredIndicesData,
FredIndicesQueryParams,
)

Parameters

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

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for.		False
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
limit	int	The number of data entries to return.	100	True
provider	Literal['intrinio']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.	intrinio	True
next_page	str	Token to get the next page of data from a previous API call.	None	True
all_pages	bool	Returns all pages of data from the API call at once.	False	True

Data

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