Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.08 KB

README.md

File metadata and controls

30 lines (21 loc) · 1.08 KB

Exchange Rates API

This project is an API that retrieves and displays exchange rates from the API of the National Bank of the Republic of Belarus.

The project is written with FastAPI and SQLAlchemy in a fully asynchronous manner. AIOHTTP is used for requests.

Prerequisites

  1. docker compose

Local launch

  1. Create .env from .example.env.
  2. Launch the project with docker compose from the project root:
docker compose up -d

The project is now available via these links:

  1. http://127.0.0.1:8000/
  2. Interactive API documentation is available here and an alternative here.
  3. The raw OpenAPI schema can be found here.

Usage notes

  1. If you don't specify a date for the endpoints, today's date will be used.
  2. To get a rate, you need to specify the internal currency code of nbrb api.