Skip to content

List of Endpoints

Osioke Itseuwa edited this page Nov 4, 2016 · 6 revisions
prefix endpoints params description
api/v2 /states none returns all states
api/v2 `/states/:state_id :state_code :state_name
api/v2 `/zone/:zone_code :zone_id` zone_code or zone_id
api/v2 `/states/:state_id :state_code :state_name/towns/urban`
api/v2 `/states/:state_id :state_code :state_name/urban/towns/:town_id`
api/v2 `/states/:state_id :state_code :state_name/urban/areas`
api/v2 `/states/:state_id :state_code :state_name/urban/areas/:area_id`
api/v2 /states/urban/streets/:state_code state_id or state_name or state_code returns all the ubran streets of a town
api/v2 `/states/:state_id :state_code :state_name/urban/streets/:street_id`
api/v2 `/states/:state_id :state_code :state_name/rural/districts`
api/v2 `/states/:state_id :state_code :state_name/rural/districts/:district_id`
api/v2 `/states/:state_id :state_code :state_name/rural/towns`
api/v2 `/states/:state_id :state_code :state_name/rural/towns/:town_id`
api/v2 `/states/:state_id :state_code :state_name/rural/lgas/`
api/v2 `/states/:state_id :state_code :state_name/rural/lgas/:lga_id`
api/v2 /streets/urban/postcode/:area_id area_id returns postcode, area_id and all the streets using the postcode

This was created using Simon's Spreadsheet 👍

Clone this wiki locally