Zimbabwe Market Rates API

This is a REST API built with Django REST framework that provides access to the latest market rates in Zimbabwe. You can use this API to get the exchange rates of various currencies, commodities and services in Zimbabwe. This is still work in process.

We welcome contribution for more details read the contribute.md file for more details on how you can contribute.

Installation

To install this project, you need to have Python and Pip installed on your system. Then, clone this repository and run the following commands:

cd Zimrates
pip install -r requirements.txt
python manage.py migrate

This will install the dependencies and create the database.

##Usage To start the server, run:

python manage.py runserver

This will launch the server on http://localhost:8000. You can use any HTTP client to make requests to the API. This API is facing one end meaning you can do POST or PATCH and this is by design.

The API supports the following endpoint:

• GET /rates - Returns a list of all available rates

The API uses JSON as the data format for both requests and responses. For example, a successful response for GET /rates might look like this:

[
  {
    "id": 1,
    "black_market": 85.0,
    "black_market_sell": 90.0,
    "created_on": "2023-09-08T17:45:58Z"
  },
  {
    "id": 2,
    "black_market": 1800.0,
    "black_market_sell": 1850.0,
    "created_on": "2023-09-08T17:45:58Z"
  }
]

License

This project is licensed under the MIT License. See the LICENSE file for details.

Disclaimer

This learning project is for educational purposes only and is not intended to be used in production. It may contain errors or omissions. It not intended for us with Zimbabwe markets as the government has offical rates you can find here.The authors of this project are not responsible for any damages or losses that may result from the use of this project.

References

This README file was generated based on the following sources:

• encode/django-rest-framework: Web APIs for Django. - GitHub
• REST API example application - GitHub: Let’s build from here
• Working with Git and GitHub | Django documentation | Django