adiresi (JS)

JavaScript client for the Adiresi API — Nigerian address resolution, NIPOST postcodes, geofencing and validation. Node 18+ or browsers, zero dependencies.

Install

npm install @adiresi/sdk

Usage

import { Adiresi } from "@adiresi/sdk";

const adr = new Adiresi("adr_your_key");

// Free-form Nigerian address → postcode + coordinates
const r = await adr.resolve({ text: "opposite Mobil, after the second gate, Lekki" });
console.log(r.status, r.postcode);

// Reuse a customer's confirmed address
const v = await adr.vaultLookup("+234 803 123 4567");
if (v.found) console.log(v.postcode, v.coordinates);

// Distance + ETA
const d = await adr.distance("6.5244,3.3792", "6.6018,3.3515", "two_wheeler");
console.log(d.distance_m, d.duration_s);

// Proof of delivery: fence the confirmed pin, ping the rider's position
await adr.createGeofence({ name: "Order 441 drop", lat: 6.4281, lng: 3.4219, radius_m: 150 });
await adr.ping({ asset_id: "rider-12", lat: 6.4283, lng: 3.422 });

// Contact data
console.log(await adr.validatePhone("0803 123 4567"));
console.log(await adr.validateEmail("[email protected]"));

All methods resolve to the decoded JSON body. Non-2xx responses throw AdiresiError with .status and .detail.

Full reference: https://api.adiresi.com.ng/docs