Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Add Fred Release Tables #6595

Merged
merged 6 commits into from
Jul 21, 2024
Merged

Conversation

deeleeramone
Copy link
Contributor

  1. Why?:

    • This feature adds a function similar to obb.economy.fred_series, but for the economic release tables.
    • Generic endpoint that returns relational table data for a specific release and date(s).
    • This function also serves as a discovery mechanism for individual FRED Series IDs that would otherwise be difficult to curate.
  2. What?:

    • New route: obb.economy.fred_release_table()
    • Required parameter is release_id.
      • Found via obb.economy.fred_search(), or from the FRED/Federal Reserve websites.
    • element_id is the specific table from the release.
      • When not supplied the top-level sections/tables are returned with IDs that can be used for drill-down.0
    • Release and Element IDs are entered as strings, despite being numeric.
    • Frequency selection is not possible via this method, however release tables are often structured where each frequency (annual, quarterly) and parameter (seasonally adjusted, etc.) are a separate table (element_id) within the release_id.
    • Each release is looked up by date, multiple dates are allowed. No date retrieves the latest observations.
  3. Impact:

    • Standard model that will likely have no use for other providers.

    • Improves the self-directed access to the vast amounts of data available from FRED.

    • Functions that curate release tables can recycle the Fetcher for specific uses.

  4. Testing Done:

    • Unit/Integration tests.
    • Variety of releases on different frequency schedules.
    • Multiple dates, single dates, no dates.

Screenshot 2024-07-19 at 8 41 50 PM

Screenshot 2024-07-19 at 8 44 15 PM

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 breaking_change labels Jul 20, 2024
@IgorWounds IgorWounds added this pull request to the merge queue Jul 21, 2024
Merged via the queue into develop with commit 938e0ae Jul 21, 2024
10 checks passed
@IgorWounds IgorWounds deleted the feature/fred-release-table branch July 21, 2024 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants