Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 1.8 KB

README.md

File metadata and controls

103 lines (64 loc) · 1.8 KB
Raw

Nigeria LGA Coordinates API

This is a simple API that provides a list of local government areas in Nigeria with their GPS coordinates. It's written in Python with Flask Framework and uses MongoDB as DataStore.

Local Government Areas (LGAs)

All LGAs have the following properties:

Field Description
stateCode State Code of the State the LGA belongs
state State the LGA belongs to
lga Name of the Local Government Area
latitude Latitude of the Local Government Area
longitude Longitude of the Local Government Area

For example, Zurmi Local Goverment in Zamfara:

  {
    "stateCode": "ZM",
    "state": "Zamfara",
    "lga": "Zurmi",
    "latitude": 12.1844159,
    "longitude": 6.2375947
  }

How to setup ?

  1. clone this repo
  2. Create a Virtual Environment for the application
virtualenv env
  1. Activate your virtual environment
source env/bin/activate
  1. Install all the project's requirements
pip install -r requirements.txt

RUN:

The Application runs on port 8080

To run, enter command :

python run.py

Anc check the endpoints in your favourite REST Client

Retrieve LGA Information

Returns data about a single LGA.

  • URL

    /api/v1/lgas/:state_name_or_code

  • Method:

    GET

  • URL Params

    Required:

    state_name_or_code=[string]

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: { "stateCode": "ZM", "state": "Zamfara", "lga": "Zurmi", "latitude": 12.1844159, "longitude": 6.2375947}

  • Error Response:

    • Code: 404 NOT FOUND
      Content: {"error": "Data not Found"}

For any questions or problems feel free to shoot me an email @ [email protected]