OpenBB/website/content/platform/reference/fixedincome/fed.md

title, description

title	description
fed	OpenBB Platform Function

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

fed

Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.

fed(start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fred)

---

Parameters

Name	Type	Description	Default	Optional
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
provider	Literal['fred']	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
parameter	Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']	Period of FED rate.	weekly	True

---

Returns

OBBject
    results : List[FEDFUNDS]
        Serializable results.

    provider : Optional[Literal['fred']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

---

Data

Name	Type	Description
date	date	The date of the data.
rate	float	FED rate.