https://github.com/rmottanet/exrate-hunter-fa
CoinSnark: RESTful API fetching & storing currency exchange rates from external APIs to Redis for CoinSnark project.
https://github.com/rmottanet/exrate-hunter-fa
api api-backend api-rest fastapi webdevelopment
Last synced: about 1 year ago
JSON representation
CoinSnark: RESTful API fetching & storing currency exchange rates from external APIs to Redis for CoinSnark project.
- Host: GitHub
- URL: https://github.com/rmottanet/exrate-hunter-fa
- Owner: rmottanet
- License: agpl-3.0
- Created: 2024-04-17T18:55:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T15:10:05.000Z (over 1 year ago)
- Last Synced: 2025-01-03T11:47:00.391Z (over 1 year ago)
- Topics: api, api-backend, api-rest, fastapi, webdevelopment
- Language: Python
- Homepage: https://web-v2gizxu6wngd.up-de-fra1-k8s-1.apps.run-on-seenode.com/
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# exRate Hunter
exRate Hunter is a Python FastAPI application developed as part of the [CoinSnark](https://rmottanet.github.io/coinsnark) project. Its primary responsibility is to provide updated data to other APIs within the CoinSnark project, enabling them to consume data from Redis without the need to update it.
## Responsibility
The application is tasked with consuming data from various external sources, such as the Central Bank of Brazil (BCB), Open Exchange Rates, and Exchange Rates API. These services provide relevant financial data, such as exchange rates.
Upon obtaining the data, the application consolidates it according to the specific business logic of the CoinSnark project. Subsequently, the consolidated data is written to Redis, an in-memory data store, for quick access by other parts of the project.
## Usage
To utilize exRate Hunter, follow these instructions:
1. Clone the repository.
2. Install the dependencies listed in the `requirements.txt` file.
3. Configure the environment variables in the `.env` file by renaming the `.env-example` file.
4. Execute the `main.py` file to start the FastAPI server.
```bash
uvicorn app.main:app --host 0.0.0.0 --port 8000
```
For more information about the CoinSnark project, please refer to the documentation: [CoinSnark GitBook](https://rmottanet.gitbook.io/coinsnark).
---
Thank you for exploring exRate Hunter. If you have any questions or suggestions regarding the project, I am happy to listen. Please feel free to get in touch.
