Metadata-Version: 2.4
Name: freder
Version: 0.0.3
Summary: FRED API Python package
Keywords: fredapi,fred,macroeconomics
Author-email: Yunjong Guk <haydenkuk@gmail.com>
Maintainer-email: Yunjong Guk <haydenkuk@gmail.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE.txt
Requires-Dist: certifi>=2025.8.3
Requires-Dist: charset-normalizer>=3.4.3
Requires-Dist: dotenv>=0.9.9
Requires-Dist: idna>=3.10
Requires-Dist: numpy>=2.3.2
Requires-Dist: pandas>=2.3.1
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: python-dotenv>=1.1.1
Requires-Dist: pytz>=2025.2
Requires-Dist: requests>=2.32.4
Requires-Dist: six>=1.17.0
Requires-Dist: tzdata>=2025.2
Requires-Dist: urllib3>=2.5.0
Project-URL: Documentation, https://github.com/haydenkuk/freder/blob/main/README.md
Project-URL: Issues, https://github.com/haydenkuk/freder/issues
Project-URL: Source, https://github.com/haydenkuk/freder

# FRED API Usage facilitator

![main workflow](https://img.shields.io/github/actions/workflow/status/haydenkuk/fred/main.yaml?logo=github)
![GitHub licence](https://img.shields.io/pypi/l/fred?logo=github)
![GitHub downloads](https://img.shields.io/github/downloads-pre/haydenkuk/fred/latest/total?logo=github)
![documentation](https://img.shields.io/readthedocs/fred?logo=readthedocs)
![PyPi download](https://img.shields.io/pypi/dm/fred?logo=pypi)
![PyPi version](https://img.shields.io/pypi/v/fred?logo=pypi)
![python version](https://img.shields.io/pypi/pyversions/fred?style=pypi)


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 freder
```
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.
