# FRED API Usage facilitator
FRED API
(https://fred.stlouisfed.org/docs/api/fred/)
Features
- All API endpoints included according to the fred docs(https://fred.stlouisfed.org/docs/api/fred/)
1. Installation
```sh
pip install fred
```
Requires Python 3.9+
2. Usage
1-1) Authentication: using dotenv
- Created a file named ".env"
- Add "FRED_APIKEY='YOURAPIKEY'" in the file
1-2) Authentication: using "set_apikey"
```python
import freder
freder.set_apikey('yourapikey')
```
2) apicalls
```python
import freder
result = freder.get_category(0)
print(result)
```
All API endpoints are included in this package,
Please refer to https://fred.stlouisfed.org/docs/api/fred/
For more API endpoints
Also, Please pay attention to docstrings of each fred functions in this package. I included fred's explanation of each input variable to facilitate the process.
Raw data
{
"_id": null,
"home_page": null,
"name": "freder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Yunjong Guk <haydenkuk@gmail.com>",
"keywords": "fredapi, fred, macroeconomics",
"author": null,
"author_email": "Yunjong Guk <haydenkuk@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/1f/c75e119cc3b154f7ec8e3233b37db87919d202378bf08a826df5460cbdef/freder-0.0.1.tar.gz",
"platform": null,
"description": "# FRED API Usage facilitator\n\n\n\n\n\n\n\n\n\n\nFRED API\n(https://fred.stlouisfed.org/docs/api/fred/)\n\nFeatures\n- All API endpoints included according to the fred docs(https://fred.stlouisfed.org/docs/api/fred/)\n\n1. Installation\n```sh\npip install fred\n```\nRequires Python 3.9+\n\n2. Usage\n\n1-1) Authentication: using dotenv\n - Created a file named \".env\"\n - Add \"FRED_APIKEY='YOURAPIKEY'\" in the file\n1-2) Authentication: using \"set_apikey\"\n```python\nimport freder\n\nfreder.set_apikey('yourapikey')\n```\n\n2) apicalls\n```python\nimport freder\n\nresult = freder.get_category(0)\nprint(result)\n```\nAll API endpoints are included in this package,\nPlease refer to https://fred.stlouisfed.org/docs/api/fred/\nFor more API endpoints\n\nAlso, Please pay attention to docstrings of each fred functions in this package. I included fred's explanation of each input variable to facilitate the process.\n",
"bugtrack_url": null,
"license": null,
"summary": "FRED API Python package",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/haydenkuk/fred/blob/main/README.md",
"Issues": "https://github.com/haydenkuk/fred/issues",
"Source": "https://github.com/haydenkuk/fred"
},
"split_keywords": [
"fredapi",
" fred",
" macroeconomics"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "650621a5d4200a03a59eabc86a918de86cd42e5f26ed8671201a011a9d10df74",
"md5": "20bea8cf79b06bc28523aeb80da9b633",
"sha256": "a3318e5571decd124b71104ef6180e2ea7a726eaa32efa8161a34993e8ec635c"
},
"downloads": -1,
"filename": "freder-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20bea8cf79b06bc28523aeb80da9b633",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 28270,
"upload_time": "2025-08-18T14:54:50",
"upload_time_iso_8601": "2025-08-18T14:54:50.470927Z",
"url": "https://files.pythonhosted.org/packages/65/06/21a5d4200a03a59eabc86a918de86cd42e5f26ed8671201a011a9d10df74/freder-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bf1fc75e119cc3b154f7ec8e3233b37db87919d202378bf08a826df5460cbdef",
"md5": "adcdfeacd6826a366a06fcb0017104e6",
"sha256": "408dc9691592e35302b43da5532bad93e248d592bab28311a45b15e610c90e15"
},
"downloads": -1,
"filename": "freder-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "adcdfeacd6826a366a06fcb0017104e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19493,
"upload_time": "2025-08-18T14:54:51",
"upload_time_iso_8601": "2025-08-18T14:54:51.822743Z",
"url": "https://files.pythonhosted.org/packages/bf/1f/c75e119cc3b154f7ec8e3233b37db87919d202378bf08a826df5460cbdef/freder-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-18 14:54:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "haydenkuk",
"github_project": "fred",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "build",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2025.8.3"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.17.1"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.3"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"45.0.6"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.22"
]
]
},
{
"name": "dotenv",
"specs": [
[
"==",
"0.9.9"
]
]
},
{
"name": "id",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "jaraco.context",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "jaraco.functools",
"specs": [
[
"==",
"4.2.1"
]
]
},
{
"name": "jeepney",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"25.6.0"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"10.7.0"
]
]
},
{
"name": "nh3",
"specs": [
[
"==",
"0.3.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.3.2"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"25.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.22"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.19.2"
]
]
},
{
"name": "pyproject_hooks",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2025.2"
]
]
},
{
"name": "readme_renderer",
"specs": [
[
"==",
"44.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.4"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"14.1.0"
]
]
},
{
"name": "SecretStorage",
"specs": [
[
"==",
"3.3.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.17.0"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"6.1.0"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2025.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.5.0"
]
]
}
],
"lcname": "freder"
}
JSON
