mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-06 01:12:27 +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>
45 lines
1.1 KiB
Markdown
Vendored
45 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: fred_ids
|
|
description: This page helps to understand the 'openbb.economy.fred_ids' function,
|
|
which is a text query method for getting series IDs on FRED via OpenBB-finance.
|
|
Includes parameters, return information and link to the source code.
|
|
keywords:
|
|
- FRED
|
|
- OpenBB-finance
|
|
- Series ID
|
|
- Information retrieval
|
|
- FRED series notes database
|
|
- openbb.economy.fred_ids
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy.fred_ids - Reference | OpenBB SDK Docs" />
|
|
|
|
Get Series IDs. [Source: FRED]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L126)]
|
|
|
|
```python
|
|
openbb.economy.fred_ids(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 IDs to output | -1 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.Dataframe | Dataframe with series IDs and titles |
|
|
---
|