naijaLGA-API

API for getting all states and Local Government Areas in Nigeria-๐Ÿ‡ณ๐Ÿ‡ฌ


About

A simple API that shows the states and Local Government Areas in Nigera, and displays them in json format, nice right ๐Ÿ‘‰, For developer who need a dropdown of States or Local government Areas in Nigeria(Not constrained to that use case only).

built with โค๏ธโ€, Django, Django Rest Framework. More details on technology used below๐Ÿ‘‡.

Versioning

We hope to improve this API on every release version, and these changes won't always be backward compatible. V1 will be live at {domain}/api/v1/ and is structured as described below๐Ÿ‘‡.


States

To get the list of all states in Nigeria, Endpoint. {domain}/api/v1/state/

{
  {
    "state": "Abia",
    "capital": "Umuahia",
    "lat": 22.92,
    "population": 2338487,
    "coord": {
      "lon": 7.515307,
      "lat": 5.454095,
    },
  },
  {
    "state": "Adamawa",
    "capital": "Yola",
    "population": 2102053,
    "coord": {
      "lon": 12.388189,
      "lat": 9.512977,
    }
  },
  ...
}

States are identified using their names, which are unique and case sensitive(state begins with an uppercase /Abia/). For example, a state: {domain}/api/v1/states/Abia/

{
    "state": "Abia",
    "capital": "Umuahia",
    "lat": 22.92,
    "population": 2338487,
    "coord": {
      "lon": 7.515307,
      "lat": 5.454095,
    },
}

States And Their LGA's

To get the list of all states and their LGA's in Nigeria, Endpoint. {domain}/api/v1/stateslga/

{
  {
    "state": "Abia",
    "capital": "Umuahia",
    "lat": 22.92,
    "population": 2845380,
    "coord": {
      "lon": 7.515307,
      "lat": 5.454095,
    },
    "lga": [
      {
        "name": "Aba North",
        "population": 106844,
        "coord": {
          "lon": 7.394788,
          "lat": 5.093863
        }
      },
      {
        "name": "Aba South",
        "population": 427421,
        "coord": {
          "lon": 7.349714,
          "lat": 5.087659
        }
      },
      {
        "name": "Arochukwu",
        "population": 169339,
        "coord": {
          "lon": 7.916667,
          "lat": 5.383333
        }
      },
      {
        "name": "Bende",
        "population": 192621,
        "coord": {
          "lon": 9.000001,
          "lat": 1e-06
        }
      },
      ...
    ]
  },
  {
    "state": "Adamawa",
    "capital": "Yola",
    "population": 3178950,
    "coord": {
      "lon": 12.388189,
      "lat": 9.512977,
    },
    "lga": [
      {
        "name": "Demsa",
        "population": 178407,
        "coord": {
          "lon": 12.150000,
          "lat": 9.466667
        }
      },
      {
        "name": "Fufore",
        "population": 209460,
        "coord": {
          "lon": 7.916667,
          "lat": 9.258518
        }
      },
      {
        "name": "Ganye",
        "population": 169948,
        "coord": {
          "lon": 11.854469,
          "lat": 8.437999
        }
      },
      {
        "name": "Gombi",
        "population": 147787,
        "coord": {
          "lon": 12.727279,
          "lat": 10.155436
        }
      },
      ...
    ]
  },
  ...
}

States and their LGA's identified using their names, which are unique and case sensitive(state begins with an uppercase /Abia/). For example, a state: {domain}/api/v1/stateslga/Abia/

{
  "state": "Abia",
  "capital": "Umuahia",
  "lat": 22.92,
  "population": 2845380,
  "coord": {
    "lon": 7.515307,
    "lat": 5.454095,
  },
  "lga": [
    {
      "name": "Aba North",
      "population": 106844,
      "coord": {
        "lon": 7.394788,
        "lat": 5.093863
      }
    },
    {
      "name": "Aba South",
      "population": 427421,
      "coord": {
        "lon": 7.349714,
        "lat": 5.087659
      }
    },
    {
      "name": "Arochukwu",
      "population": 169339,
      "coord": {
        "lon": 7.916667,
        "lat": 5.383333
      }
    },
    {
      "name": "Bende",
      "population": 192621,
      "coord": {
        "lon": 9.000001,
        "lat": 1e-06
      }
    },
    ...
  ]
}

List of endpoints

This is just a summary of all four endpoints you can call.

  • GET /states/ returns a list of all states in Nigeria.
  • GET /states/<state_name>/ returns a state. pass in the state name i.e Abuja.
  • GET /stateslga/ returns a list of all states and their LGA's in Nigeria.
  • GET /stateslga/<state_name>/ returns a state and it's LGA's. pass in the state name i.e Abuja.

Using Django Rest Freamework(DRF)

Django REST framework is a powerful and flexible toolkit for building Web APIs ๐Ÿ‘‰ more details.


Contributions

Contributions are always welcome! Please read the Contribution guidelines for this project.

Naijalga API

API for getting all states and Local Government Areas in Nigeria-๐Ÿ‡ณ๐Ÿ‡ฌ

Naijalga API Info

โญ Stars 10
๐Ÿ”— Homepage naijalga.herokuapp.com
๐Ÿ”— Source Code github.com
๐Ÿ•’ Last Update a year ago
๐Ÿ•’ Created 3 years ago
๐Ÿž Open Issues 0
โž— Star-Issue Ratio Infinity
๐Ÿ˜Ž Author silvareal