{
"info": {
"author": "Mortada Mehyar",
"author_email": "",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Science/Research",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Topic :: Internet :: WWW/HTTP",
"Topic :: Software Development :: Libraries :: Python Modules"
],
"description": "fredapi: Python API for FRED (Federal Reserve Economic Data)\n============================================================\n\n``fredapi`` is a Python API for the\n`FRED `__ data provided by the\nFederal Reserve Bank of St. Louis. ``fredapi`` provides a wrapper in\npython to the `FRED web\nservice `__, and also provides\nseveral conveninent methods for parsing and analyzing point-in-time data\n(i.e. historic data revisions) from\n`ALFRED `__\n\n``fredapi`` makes use of ``pandas`` and returns data to you in a\n``pandas`` ``Series`` or ``DataFrame``\n\nInstallation\n------------\n\n.. code:: sh\n\n pip install fredapi\n\nBasic Usage\n-----------\n\nFirst you need an API key, you can `apply for\none `__ for free on the FRED\nwebsite. Once you have your API key, you can set it in one of three\nways:\n\n- set it to the evironment variable FRED\\_API\\_KEY\n- save it to a file and use the 'api\\_key\\_file' parameter\n- pass it directly as the 'api\\_key' parameter\n\n.. code:: python\n\n from fredapi import Fred\n fred = Fred(api_key='insert api key here')\n data = fred.get_series('SP500')\n\nWorking with data revisions\n---------------------------\n\nMany economic data series contain frequent revisions. ``fredapi``\nprovides several convenient methods for handling data revisions and\nanswering the quesion of what-data-was-known-when.\n\nIn `ALFRED `__ there is the\nconcept of a *vintage* date. Basically every *observation* can have\nthree dates associated with it: *date*, *realtime\\_start* and\n*realtime\\_end*.\n\n- date: the date the value is for\n- realtime\\_start: the first date the value is valid\n- realitime\\_end: the last date the value is valid\n\nFor instance, there has been three observations (data points) for the\nGDP of 2014 Q1:\n\n.. code:: xml\n\n \n \n \n\nThis means the GDP value for Q1 2014 has been released three times.\nFirst release was on 4/30/2014 for a value of 17149.6, and then there\nhave been two revisions on 5/29/2014 and 6/25/2014 for revised values of\n17101.3 and 17016.0, respectively.\n\nGet first data release only (i.e. ignore revisions)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n data = fred.get_series_first_release('GDP')\n\nGet latest data\n~~~~~~~~~~~~~~~\n\nNote that this is the same as simply calling ``get_series()``\n\n.. code:: python\n\n data = fred.get_series_latest_release('GDP')\n\nGet latest data known on a given date\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n fred.get_series_as_of_date('GDP', '6/1/2014')\n\nGet all data release dates\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis returns a ``DataFrame`` with all the data from ALFRED\n\n.. code:: python\n\n df = fred.get_series_all_releases('GDP')\n df.tail()\n\nGet all vintage dates\n~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n vintage_dates = fred.get_series_vintage_dates('GDP')\n\nSearch for data series\n~~~~~~~~~~~~~~~~~~~~~~\n\nYou can always search for data series on the FRED website. But sometimes\nit can be more convenient to search programmatically. ``fredapi``\nprovides a ``search()`` method that does a fulltext search and returns a\n``DataFrame`` of results.\n\n.. code:: python\n\n fred.search('potential gdp')\n\nYou can also search by release id and category id with various options\n\n.. code:: python\n\n df1 = fred.search_by_release(11)\n df2 = fred.search_by_category(101, limit=10, order_by='popularity', sort_order='desc')\n\nDependencies\n------------\n\n- `pandas `__\n\nMore Examples\n-------------\n\n- I have a `blog post with more examples `__ written in an `IPython` notebook\n\n\n",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/mortada/fredapi",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "fredapi",
"package_url": "https://pypi.org/project/fredapi/",
"platform": "Any",
"project_url": "https://pypi.org/project/fredapi/",
"project_urls": {
"Homepage": "https://github.com/mortada/fredapi"
},
"release_url": "https://pypi.org/project/fredapi/0.4.2/",
"requires_dist": [
"pandas"
],
"requires_python": "",
"summary": "Python API for Federal Reserve Economic Data (FRED) from St. Louis Fed",
"version": "0.4.2"
},
"last_serial": 4714822,
"releases": {
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "8e39606131dff35c89adc4ef9cbb95d3",
"sha256": "77211f7ce6baa07c8368b12f74f005de345d7a5537ece21ba994abab878b41d2"
},
"downloads": -1,
"filename": "fredapi-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "8e39606131dff35c89adc4ef9cbb95d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5924,
"upload_time": "2014-08-24T04:25:26",
"url": "https://files.pythonhosted.org/packages/cd/a1/3468e09833159e3e24c223ba20e885cc5775f69041e319aacd291ed80c69/fredapi-0.2.1.tar.gz"
}
],
"0.3.0": [
{
"comment_text": "",
"digests": {
"md5": "0c309ebf6243c035780584a3ae952955",
"sha256": "47f36446f9fdb48074baf09560eac771fbd8fedbc9e189dcde728e97d9c19f3d"
},
"downloads": -1,
"filename": "fredapi-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0c309ebf6243c035780584a3ae952955",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7961,
"upload_time": "2014-10-11T15:01:17",
"url": "https://files.pythonhosted.org/packages/08/12/c69484b00c41865dfa8ad21b80c5196b41355377d16f2daef75c9433af94/fredapi-0.3.0.tar.gz"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "1eae00f85eed1ab2ed48254dad36afe4",
"sha256": "1de4849365df2ac26c876f2ef24769f75c0e798de7354a18e6c14891e21445ce"
},
"downloads": -1,
"filename": "fredapi-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "1eae00f85eed1ab2ed48254dad36afe4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8343,
"upload_time": "2014-11-09T01:37:50",
"url": "https://files.pythonhosted.org/packages/bd/a1/d924f5b48e74c714e387eba8e43792abf9265328f92703621e36f47eea81/fredapi-0.3.1.tar.gz"
}
],
"0.3.2": [
{
"comment_text": "",
"digests": {
"md5": "db430b9ddfbb55effa166672d52e9338",
"sha256": "f572f94c48379829bd399ed1c0a6f5fe1cfd5131abfca40ebf50bb61b4d72696"
},
"downloads": -1,
"filename": "fredapi-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "db430b9ddfbb55effa166672d52e9338",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8388,
"upload_time": "2015-01-14T05:04:25",
"url": "https://files.pythonhosted.org/packages/48/56/c5096a51bdd05e8731c41edbdcbc2ba6bddf4bc2c732b485d5683027e2e8/fredapi-0.3.2.tar.gz"
}
],
"0.3.3": [
{
"comment_text": "",
"digests": {
"md5": "8951752a1a9c063e4226126d7690d355",
"sha256": "3f47c1b0b3f0fa72e1207e834c06d81b4adad5144682796759b98b704183c91f"
},
"downloads": -1,
"filename": "fredapi-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "8951752a1a9c063e4226126d7690d355",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8353,
"upload_time": "2015-03-02T17:55:39",
"url": "https://files.pythonhosted.org/packages/2f/82/b9ac64dce515edbfb747e313a7a88e3689505045a1b7b94a71cc1c74051c/fredapi-0.3.3.tar.gz"
}
],
"0.3.4": [
{
"comment_text": "",
"digests": {
"md5": "d4b4f97ac59c40936552bdfe6325ffaa",
"sha256": "7726cc99161a7a09173b9630691b6aebaa74d5cdb19f35d1621a016fe690f094"
},
"downloads": -1,
"filename": "fredapi-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "d4b4f97ac59c40936552bdfe6325ffaa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8373,
"upload_time": "2015-03-03T18:29:04",
"url": "https://files.pythonhosted.org/packages/c8/4f/34cf4e9d1fd359d03c4c0c848c2fe53e41e7da7dec1834286dfc519f97f0/fredapi-0.3.4.tar.gz"
}
],
"0.3.5": [
{
"comment_text": "",
"digests": {
"md5": "ebded3e3a1269d27059400deff91c61d",
"sha256": "5a59e8b32553c4f8028f7dec1171a2691bdcf69b613a18f864324ef96712083b"
},
"downloads": -1,
"filename": "fredapi-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "ebded3e3a1269d27059400deff91c61d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8434,
"upload_time": "2015-05-20T16:43:42",
"url": "https://files.pythonhosted.org/packages/f9/2c/332c0a992a0428598fcd3c215b19fcc7ec25311fc444562e0ec58be50390/fredapi-0.3.5.tar.gz"
}
],
"0.3.6": [
{
"comment_text": "",
"digests": {
"md5": "f25b85d09ba34379e8ddd18d2baa0825",
"sha256": "6bdc5b2b45ec006f886c7ae8ed64909386083192cf96f7dce0a6341c9162a414"
},
"downloads": -1,
"filename": "fredapi-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "f25b85d09ba34379e8ddd18d2baa0825",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8472,
"upload_time": "2015-05-25T18:32:05",
"url": "https://files.pythonhosted.org/packages/e3/d1/853e3b7adc4a8a87c0935454487778b25ecbf21c9c5a71475a80646d9e39/fredapi-0.3.6.tar.gz"
}
],
"0.3.7": [
{
"comment_text": "",
"digests": {
"md5": "55c5fe40f54078ba288a398b0ea055a4",
"sha256": "f4808d6ade8072a57ad292be489f576f4b7a1e49de96fe60054d76262439ee56"
},
"downloads": -1,
"filename": "fredapi-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "55c5fe40f54078ba288a398b0ea055a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8555,
"upload_time": "2015-07-12T16:27:58",
"url": "https://files.pythonhosted.org/packages/67/2b/056e6e3fdc5edfdbc97bc4e5547e07d83921f9c38c7383d930d6972234e1/fredapi-0.3.7.tar.gz"
}
],
"0.4.0": [
{
"comment_text": "",
"digests": {
"md5": "cf5e5546556362fcf8bfa5bc5fa30e9b",
"sha256": "5b422c86e7eaaa6ed0b7f4e1a5f099ee371e5c7d6c5e78fc8e0f378cd1ced7f7"
},
"downloads": -1,
"filename": "fredapi-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "cf5e5546556362fcf8bfa5bc5fa30e9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8665,
"upload_time": "2017-06-18T08:29:28",
"url": "https://files.pythonhosted.org/packages/dc/10/add55548c9ef5fe9bd48765eb2fc250527f7e2e7fc77f721ee13aeca84a8/fredapi-0.4.0.tar.gz"
}
],
"0.4.1": [
{
"comment_text": "",
"digests": {
"md5": "d3bf207d3d058fa8796ceaebe5b9c608",
"sha256": "11d8143a7fa8a3a7c6b0ef351a4dd5da0c287a152eb778a6b1481a39ffdcbf01"
},
"downloads": -1,
"filename": "fredapi-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "d3bf207d3d058fa8796ceaebe5b9c608",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8691,
"upload_time": "2017-09-03T02:34:18",
"url": "https://files.pythonhosted.org/packages/3f/6b/c6652a9d71966bf071247289f80e5ee330b154aecb43d01eee61e0a4a8e2/fredapi-0.4.1.tar.gz"
}
],
"0.4.2": [
{
"comment_text": "",
"digests": {
"md5": "0157d5515e2e2d34d81f4fd13398c279",
"sha256": "1904669527621b25179577cfd61feae75c3ebffd16cbf7e9e55a5abc657de249"
},
"downloads": -1,
"filename": "fredapi-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0157d5515e2e2d34d81f4fd13398c279",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11504,
"upload_time": "2019-01-19T07:29:43",
"url": "https://files.pythonhosted.org/packages/8e/46/c779a9389b39007ac154c1a66871bdb3a712b149fd5a82fb0b7f5267fe48/fredapi-0.4.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "dd7515734540d6ba7ebb8e80cd1de814",
"sha256": "753eb21fd75b461d36177eb9da298d1e0ec3ccfd4f64e13e74ffc216a89a2b96"
},
"downloads": -1,
"filename": "fredapi-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "dd7515734540d6ba7ebb8e80cd1de814",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13683,
"upload_time": "2019-01-19T07:29:44",
"url": "https://files.pythonhosted.org/packages/5d/ed/b160d96b60b4f669c59c7ebb1e3d1e41209e1b7ba329b42801370ad4ecf5/fredapi-0.4.2.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0157d5515e2e2d34d81f4fd13398c279",
"sha256": "1904669527621b25179577cfd61feae75c3ebffd16cbf7e9e55a5abc657de249"
},
"downloads": -1,
"filename": "fredapi-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0157d5515e2e2d34d81f4fd13398c279",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11504,
"upload_time": "2019-01-19T07:29:43",
"url": "https://files.pythonhosted.org/packages/8e/46/c779a9389b39007ac154c1a66871bdb3a712b149fd5a82fb0b7f5267fe48/fredapi-0.4.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "dd7515734540d6ba7ebb8e80cd1de814",
"sha256": "753eb21fd75b461d36177eb9da298d1e0ec3ccfd4f64e13e74ffc216a89a2b96"
},
"downloads": -1,
"filename": "fredapi-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "dd7515734540d6ba7ebb8e80cd1de814",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13683,
"upload_time": "2019-01-19T07:29:44",
"url": "https://files.pythonhosted.org/packages/5d/ed/b160d96b60b4f669c59c7ebb1e3d1e41209e1b7ba329b42801370ad4ecf5/fredapi-0.4.2.tar.gz"
}
]
}