Skip to content

Johnkayode/ExploreNaija

Repository files navigation

Explore Naija

API for Nigerian states and capitals, cities, towns and tourist centres.

Built with Django and Django Rest Framework (DRF)

Installation

install docker from here

create docker image

docker build .

API Reference

Check out the full API docs here

List all states Get a particular city or state

  GET /v1/cities-towns/
Parameter Type Description
name string (query) Get a particular Nigerian city or town by its name

List all states Get a particular state

  GET /v1/states/
Parameter Type Description
name string (query) Get a particular Nigerian state by its name

Get all tourist centres Get a particular tourist centre

  GET /v1/tourist-centres/
Parameter Type Description
name string (query) Get a particular Nigerian tourist centre by its name(s)
town string (query) Filter the tourist centres by the name of a Nigerian town
state string (query) Filter the tourist centres by the name of a Nigerian state