mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
46 lines
1.2 KiB
Markdown
Vendored
46 lines
1.2 KiB
Markdown
Vendored
---
|
|
title: fred_notes
|
|
description: Learn about OpenBB's FRED model and how it makes searching the series
|
|
notes database easier. This page also talks about the search and limit parameters
|
|
involved when querying the FRED database, and the DataFrame of matched series it
|
|
returns.
|
|
keywords:
|
|
- FRED series notes
|
|
- OpenBB economy
|
|
- FRED model
|
|
- data searching
|
|
- text query
|
|
- series notes database
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy.fred_notes - Reference | OpenBB SDK Docs" />
|
|
|
|
Get series notes. [Source: FRED]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L68)]
|
|
|
|
```python
|
|
openbb.economy.fred_notes(search_query: str, limit: int = -1)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| search_query | str | Text query to search on fred series notes database | None | False |
|
|
| limit | int | Maximum number of series notes to display | -1 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | DataFrame of matched series |
|
|
---
|