Service description & endpoints

Extraits de code

curl "https://api.oanor.com/postcode-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/postcode-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/postcode-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/postcode-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Exemple de réponse

Une réponse réelle de ce endpoint, capturée lors du dernier contrôle de santé.

{
    "data": {
        "service": "postcode-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/lookup": "Full details for a postcode (postcode=).",
            "GET /v1/random": "A random postcode.",
            "GET /v1/nearest": "Postcodes near a postcode (postcode=, limit=).",
            "GET /v1/outcode": "Outcode (area) detail (outcode=, e.g. SW1A).",
            "GET /v1/reverse": "Nearest postcodes to coordinates (lat=, lon=, radius=, limit=).",
            "GET /v1/validate": "Validate a postcode (postcode=).",
            "GET /v1/autocomplete": "Autocomplete a partial postcode (postcode=)."
        },
        "description": "UK postcode & geography lookup via postcodes.io: resolve a postcode to coordinates and administrative areas (district, ward, county, parliamentary constituency, region, NHS area), validate a postcode, reverse-geocode coordinates to the nearest postcodes, find nearby postcodes, autocomplete a partial postcode, look up an outcode and fetch a random postcode. Real data, no key."
    },
    "meta": {
        "timestamp": "2026-06-08T01:19:43.901Z",
        "request_id": "3b00c7fa-0846-4a11-9afe-28169f940d4a"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}