Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 1.11 KB

README.md

File metadata and controls

38 lines (31 loc) · 1.11 KB
Raw

A currency convertor API

Prerequisites

  1. Get a free API key from API Layer["https://apilayer.com/marketplace/exchangerates_data-api"] for the Exchange rates API. The Exchange rates API gives real time foreign exchange rates. To obtain an API key you must create an account.

How to start the API

  1. Clone the git repository using the command
git clone https://github.com/tsitsiflora/currency_converter.git
  1. Traverse into the convertor directory
  2. Create a virtual environment for the project:
python3 -m venv venv
  1. Install the requirements:
pip3 install -R requirements.txt
  1. Make a file call ACCESS_KEY.py and put your API key in there. For example:
YOUR_ACCESS_KEY = "randomstringhere"
  1. Start the API using
uvicorn main:app --reload
  1. The API will run at 127.0.0.1:8000. You can visit the address in your browser
  2. You can use the docs at 127.0.0.1:8000/docs to test the API or use curl

API Endpoints

  • /: this is the index point
  • /all: this retrieves all currencies supported by the API
  • /convert: this converts one currency into another