OpenHealth NG

Version 1.0.0

API Documentation

OpenHealth NG provides a public, free-to-use API for accessing healthcare facility data across Nigeria. Designed for developers, researchers, and civic tech organizations.

System Architecture

Built with modern web technologies focusing on performance, type safety, and scalability. The system follows a RESTful architecture with a backend-for-frontend (BFF) pattern using Next.js App Router.

Frontend / API Layer

  • Next.js 15 (App Router)
  • React Server Components
  • TypeScript (Strict Mode)
  • Tailwind CSS

Data & Infrastructure

  • Supabase (PostgreSQL)
  • Row Level Security (RLS)
  • Edge Caching
  • Vercel Deployment

Base URL

https://openhealth-ng.vercel.app/api/v1

All responses are in JSON format.

Endpoints

Health Facilities

GET/facilities

Retrieve a list of healthcare facilities. Supports filtering.

Query Parameters

  • stateFilter by Nigerian state (e.g. "Lagos")
  • facility_typeFilter by type (hospital, clinic, pharmacy, laboratory)

Services

GET/services

List available medical services found in the registry.

Query Parameters

  • facility_idGet services specific to a facility UUID

Emergency Contacts

GET/emergency

Get a list of emergency response numbers (Ambulance, Fire, Police).

Contributing

OpenHealth NG is open source. Contributors are welcome to help improve data accuracy and API coverage.