Côte d’Ivoire home codes

What a code is

Every compound in Côte d’Ivoire has an N-Ways code: the short name of its quartier, village or cité and a number of four or five digits, such as Bonoumin 6136 or Remblais 2966. Each code is unique in the whole country on its own and leads to the compound’s gate. Codes start provisional and become confirmed when residents agree in the N-Ways app.

• Remembered form, what people say and type: Bonoumin 6136, also in pairs (bonoumin 61 36) or after a dot (Bonoumin · 61 36). Any case and the usual spellings (Koffikro = Kofikro, Riviéra II = Riviera 2), the official name in place of the short one (Koumassi remblais 2966 = Remblais 2966).
• Written form, on plates and forms: Bonoumin 61 36 (Cocody). The commune in brackets is a label only. People never see or type a check digit.
• Machine form, for systems, QR codes and links: CI-010114-083-6136-2 (the unit, the area, the number and a Damm check digit that catches every single wrong digit and every swap of two neighbouring digits; .2/1 after it for building 2, gate 1).
• Spot code, for any point: its Plus Code, 926H+7Q7 Cocody or 6CQR926H+7Q7, readable by any Plus Code app.

Where the State has given the gate an address (PADA in Abidjan, later PAVI), it comes first, in officialAddress, with the N-Ways code beside it. No commune or sous-préfecture is needed to decode a code; municipality is looked up from the position. The model, the engine and the registry of every code are open: github.com/n-ways/open-addresses-cote-divoire. The white paper explains every rule.

Look up a code

GET https://map.nways.ng/v1/homecodes/{code}, where code is the remembered, written or machine form, or a Plus Code on a compound, URL-encoded. No key is needed.

curl "https://map.nways.ng/v1/homecodes/CI-010114-083-6136-2"

{
  "country": "CI",
  "home": "Bonoumin 6136",
  "machine": "CI-010114-083-6136-2",
  "check": 2,
  "name": "Bonoumin",
  "nameProvisional": false,
  "municipality": "Cocody",
  "fullLine": "Bonoumin 61 36 (Cocody)",
  "spoken": "Bonoumin, 61 36",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 5.3606529, "lng": -3.9705867, "kind": "centre", "source": "map" },
  "location": { "lat": 5.3606529, "lng": -3.9705867 },
  "plusCode": "6CQR926H+7Q7",
  "lote": { "use": "residential", "kind": "building", "class": "residential", "structures": 1, "floorAreaM2": 77.7, "rule": "single" },
  "credit": "N-Ways Addressing for Côte d'Ivoire, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-cote-divoire"
}

Errors: 400 homecode_format when the text isn’t a code; 404 homecode_unknown with a message saying why (a name no area has, a number in no block, a commune that contradicts the code).

What’s the code here?

GET https://map.nways.ng/v1/homecodes/at?lat=…&lng=… answers for a point: "status": "found" with the code, or "none" where no compound has one yet.

curl "https://map.nways.ng/v1/homecodes/at?lat=5.36065&lng=-3.97059"

Search

A code typed into N-Ways search, in any of its forms, finds the compound’s gate as the first result, with "category": "homecode" and the credit in attribution.

Decode offline

The repository’s reference engine (Python, standard library only) decodes every form, checks the machine form and reads and writes Plus Codes, with no network: python3 engine/reference/ci_engine.py parse "Bonoumin 61 36". Its conformance vectors (engine/reference/vectors.json) are the test for your own implementation, engine/data/register.json holds every unit, name and area with its frozen blocks, and registry/ every issued code, one gzip file per unit.

Host it yourself

You can serve Côte d’Ivoire’s codes from your own servers, with no calls to N-Ways. The repository on GitHub holds every issued code (registry/), the code areas and the model (model/), the reference engine, and a ready-made registry server with its JSON API:

git clone https://github.com/n-ways/open-addresses-cote-divoire
cd open-addresses-cote-divoire
docker compose up -d

The server imports the registry on first start, then answers lookups and searches on your machine; server/README.md covers configuration, backups and updates, and docs/api.md every endpoint. Your copy is read-only: new codes come from one issuer per country, N-Ways unless the State designates another, so no number is ever given twice. Pull the repository again for the codes issued since.

The full terms, and the credit line for maps and datasets made from the data (it also names OpenStreetMap), are in LICENSING.md. You may say your product uses N-Ways Addressing, not that it is N-Ways or is endorsed by N-Ways.