Interactive API Explorer
OpenGrid API
Try any endpoint live. Pick a facility type, filter by state or LGA, and see the real response — no setup needed.
Explore Facilities
GET/api/facilities?limit=10
Response
Set your filters and click Run Request to see a live response.
Endpoint Reference
All endpoints return JSON. No authentication required.
GET/api/facilitiesList facilities. Filter by type, state, LGA, or free-text search.
| Parameter | Type | Description |
|---|---|---|
type | string | Facility type (e.g. school, market, health_facility) |
state | string | State slug (e.g. lagos, kano) |
lga | string | LGA slug (e.g. ikeja-ikeja) |
q | string | Free-text search across name, LGA, state |
source | string | "grid3" or "community" |
limit | number | Results per page (1–100, default 20) |
offset | number | Pagination offset (default 0) |
order | string | "asc" or "desc" by name |
GET/api/facilities/:slugGet a single facility by its slug.
GET/api/typesList all 15 facility types with record counts.
GET/api/statesList all 36 states and the FCT.
GET/api/states/:slugGet a single state with LGA count and facility count.
GET/api/lgasList all LGAs, optionally filtered by state.
| Parameter | Type | Description |
|---|---|---|
state | string | State slug to filter by |
GET/api/lgas/:slugGet a single LGA with facility count.
GET/api/coverageFull coverage summary: per-type counts and per-state facility counts.
POST/api/contributeSubmit a new facility. Opens a GitHub pull request automatically.
| Parameter | Type | Description |
|---|---|---|
facility_name | string | Required. Name of the facility |
facility_type | string | Required. One of the 15 facility types |
state | string | Required. State name or slug |
lga | string | Required. LGA name or slug |
lat | number | Required. Latitude (3–15) |
lng | number | Required. Longitude (1–16) |
contributor_name | string | Optional. Your name or GitHub username |
description | string | Optional. Notes about the facility |
Facility Types
Pass these exact values to the type= query parameter.