{"id":13700008,"url":"https://github.com/avelkoski/FRB","last_synced_at":"2025-05-04T18:34:00.761Z","repository":{"id":57432155,"uuid":"49373629","full_name":"avelkoski/FRB","owner":"avelkoski","description":"Python Client for Interfacing with the Federal Reserve Bank of St. Louis' Economic Data API (FRED®)","archived":false,"fork":false,"pushed_at":"2023-07-07T10:06:29.000Z","size":46,"stargazers_count":161,"open_issues_count":9,"forks_count":41,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-28T10:42:31.358Z","etag":null,"topics":["economic-data","economic-indicators","federal-reserve","fred-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avelkoski.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-01-10T15:55:11.000Z","updated_at":"2024-04-18T00:37:54.000Z","dependencies_parsed_at":"2023-10-20T17:58:47.730Z","dependency_job_id":"220dc845-9df0-4572-b837-c89070ea8b56","html_url":"https://github.com/avelkoski/FRB","commit_stats":{"total_commits":20,"total_committers":5,"mean_commits":4.0,"dds":"0.44999999999999996","last_synced_commit":"692bcf576e17bd1a81db2b7644f4f61aeb39e5c7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelkoski%2FFRB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelkoski%2FFRB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelkoski%2FFRB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelkoski%2FFRB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avelkoski","download_url":"https://codeload.github.com/avelkoski/FRB/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252382839,"owners_count":21739225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["economic-data","economic-indicators","federal-reserve","fred-api"],"created_at":"2024-08-02T20:00:47.099Z","updated_at":"2025-05-04T18:33:57.276Z","avatar_url":"https://github.com/avelkoski.png","language":"Python","funding_links":[],"categories":["Python","Economic \u0026 Macro Data"],"sub_categories":["Data Sources","Federal Reserve \u0026 Central Banks"],"readme":"Python Client for FRED® API\n===========================\nPython client for interfacing with the Federal Reserve Bank's\nFRED API. Our goal is to provide a simple, well-documented\nsolution for FRED-related programming in Python.\n\n::\n\n  This is a third-party client that is developed and maintained\n  independently of the Federal Reserve Bank. As such, it is not\n  affiliated with or supported by the institution.\n\nFeatures\n--------\n\nThis client was built to provide users with an intuitive\nand effective framework for making requests to the FRED API\nfrom within Python. As such, our main feature is the\nability to interact with the FRED web-service.\n\nComprehensive query support\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nRequest economic data from all 5 data groups available in FRED and ALFRED.\nFor reference, the data groups are included below.\nSee `Federal Reserve Bank of St. Louis`_  for additional documentation,\nor click on a specific query to go directly to documentation for that query.\n\n.. _Federal Reserve Bank of St. Louis: https://research.stlouisfed.org/docs/api/fred/\n\n* **Categories**\n\n  * `fred/category`_ - Get a category.\n  * `fred/category/children`_ - Get the child categories for a specified parent category.\n  * `fred/category/related`_ - Get the related categories for a category.\n  * `fred/category/series`_ - Get the series in a category.\n  * `fred/category/tags`_ - Get the tags for a category.\n  * `fred/category/related_tags`_ - Get the related tags for a category.\n\n.. _fred/category: https://research.stlouisfed.org/docs/api/fred/category.html\n.. _fred/category/children: https://research.stlouisfed.org/docs/api/fred/category_children.html\n.. _fred/category/related: https://research.stlouisfed.org/docs/api/fred/category_related.html\n.. _fred/category/series: https://research.stlouisfed.org/docs/api/fred/category_series.html\n.. _fred/category/tags: https://research.stlouisfed.org/docs/api/fred/category_tags.html\n.. _fred/category/related_tags: https://research.stlouisfed.org/docs/api/fred/category_related_tags.html\n\n* **Releases**\n\n  * `fred/releases`_ - Get all releases of economic data.\n  * `fred/releases/dates`_ - Get release dates for all releases of economic data.\n  * `fred/release`_ - Get a release of economic data.\n  * `fred/release/dates`_ - Get release dates for a release of economic data.\n  * `fred/release/series`_ - Get the series on a release of economic data.\n  * `fred/release/sources`_ - Get the sources for a release of economic data.\n  * `fred/release/tags`_ - Get the tags for a release.\n  * `fred/release/related_tags`_ - Get the related tags for a release.\n\n.. _fred/releases: https://research.stlouisfed.org/docs/api/fred/releases.html\n.. _fred/releases/dates: https://research.stlouisfed.org/docs/api/fred/releases_dates.html\n.. _fred/release: https://research.stlouisfed.org/docs/api/fred/release.html\n.. _fred/release/dates: https://research.stlouisfed.org/docs/api/fred/release_dates.html\n.. _fred/release/series: https://research.stlouisfed.org/docs/api/fred/release_series.html\n.. _fred/release/sources: https://research.stlouisfed.org/docs/api/fred/release_sources.html\n.. _fred/release/tags: https://research.stlouisfed.org/docs/api/fred/release_tags.html\n.. _fred/release/related_tags: https://research.stlouisfed.org/docs/api/fred/release_related_tags.html\n\n* **Series**\n\n  * `fred/series`_ - Get an economic data series.\n  * `fred/series/categories`_ - Get the categories for an economic data series.\n  * `fred/series/observations`_ - Get the observations or data values for an economic data series.\n  * `fred/series/search`_ - Get economic data series that match keywords.\n  * `fred/series/release`_ - Get the release for an economic data series.\n  * `fred/series/search/tags`_ - Get the tags for a series search.\n  * `fred/series/search/related_tags`_ - Get the related tags for a series search.\n  * `fred/series/tags`_ - Get the tags for an economic data series.\n  * `fred/series/updates`_ - Get economic data series sorted by when observations were updated on the FRED server.\n  * `fred/series/vintagedates`_ - Get the dates in history when a series' data values were revised or new data values were released.\n\n.. _fred/series: https://research.stlouisfed.org/docs/api/fred/series.html\n.. _fred/series/categories: https://research.stlouisfed.org/docs/api/fred/series_categories.html\n.. _fred/series/observations: https://research.stlouisfed.org/docs/api/fred/series_observations.html\n.. _fred/series/release: https://research.stlouisfed.org/docs/api/fred/series_release.html\n.. _fred/series/search:  https://research.stlouisfed.org/docs/api/fred/series_search.html\n.. _fred/series/search/tags: https://research.stlouisfed.org/docs/api/fred/series_search_tags.html\n.. _fred/series/search/related_tags: https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html\n.. _fred/series/tags: https://research.stlouisfed.org/docs/api/fred/series_tags.html\n.. _fred/series/updates: https://research.stlouisfed.org/docs/api/fred/series_updates.html\n.. _fred/series/vintagedates: https://research.stlouisfed.org/docs/api/fred/series_vintagedates.html\n\n* **Sources**\n\n  * `fred/sources`_ - Get all sources of economic data.\n  * `fred/source`_ - Get a source of economic data.\n  * `fred/source/releases`_ - Get the releases for a source.\n\n.. _fred/sources: https://research.stlouisfed.org/docs/api/fred/sources.html\n.. _fred/source: https://research.stlouisfed.org/docs/api/fred/source.html\n.. _fred/source/releases: https://research.stlouisfed.org/docs/api/fred/source_releases.html\n\n* **Tags**\n\n  * `fred/tags`_ - Get all tags, search for tags, or get tags by name.\n  * `fred/related_tags`_ - Get the related tags for one or more tags.\n  * `fred/tags/series`_ - Get the series matching tags.\n\n.. _fred/tags: https://research.stlouisfed.org/docs/api/fred/tags.html\n.. _fred/related_tags: https://research.stlouisfed.org/docs/api/fred/related_tags.html\n.. _fred/tags/series: https://research.stlouisfed.org/docs/api/fred/tags_series.html\n\nPopular response transformations\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTransform data from http responses to your preferred format,\nallowing you to focus more time on data integration and analysis\nand less on response processing. If you prefer raw responses from FRED,\nso that you can conduct your own response parsing, simply set ``response_type``\nto *xml* or *json* (standard FRED responses). Otherwise, automatically\ntransform data into comma, tab, or pipe separated values,\npython dictionaries, pandas dataframes, or numpy arrays.\n\nFor dictionary, dataframe, and array responses, an attempt is made to\nconvert data to more useful dtypes. For example, ``realtime_start``\nand ``realtime_end`` response data are automatically converted\nfrom a string to *datetime64* numpy dtype. Similarly, counts\nand IDs (where appropriate) are converted to *int* while observation\nmeasures are converted to *float*.\n\n\n.. _fva-label:\n\nInstallation\n------------\n\nInstall via ``pip``:\n\n::\n\n    pip install FRB\n\n\n``Git`` clone from the command line:\n\n::\n\n    git clone http://github.com/avelkoski/FRB.git\n\nDownload directly from `Github`_.\n\n  .. _Github: https://github.com/avelkoski/FRB/archive/master.zip\n\n\nBasic usage\n-------------\n::\n\n    from fred import Fred\n    fr = Fred(api_key='abcdefghijklmnopqrstuvwxyz123456',response_type='dict')\n\n    params = {\n             'limit':2,\n             'tag_names':'trade;goods'\n             }\n\n    res = fr.category.series(125,params=params)\n\n    for record in res:\n        print(record)\n\n\nRead the Docs\n-------------\n\nFor additional detail about this package, read our `documentation`_ .\n\n  .. _documentation: http://frb.rtfd.org\n\n\nLicense\n-------\n\nThe MIT License (MIT)\n\nCopyright (c) 2016 Aleksandar Velkoski avelkoski@realtors.org\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\nAffiliation\n-----------\n\nThe author is affiliated with the Data Science division of\nthe National Association of REALTORS®.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favelkoski%2FFRB","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favelkoski%2FFRB","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favelkoski%2FFRB/lists"}