API JSON

L'API retourne les données au format JSON (UTF-8). Tous les appels se font en GET.

Paramètres

Paramètre	Description	Exemple
cp	Code postal exact (5 chiffres)	api.php?cp=75001
commune	Nom de commune (recherche partielle)	api.php?commune=Lyon
insee	Code INSEE exact	api.php?insee=75056
id	Identifiant interne de la ligne	api.php?id=1

Format de réponse

{
  "status": "success",
  "count": 1,
  "data": [
    {
      "id": 12345,
      "code_postal": "75001",
      "code_insee": "75101",
      "commune": "Paris 1er Arrondissement",
      "departement": "75",
      "region": "Île-de-France",
      "latitude": 48.86,
      "longitude": 2.35,
      "population": 17915,
      "pop_mun": 17915,
      "pop_totale": 17915
    }
  ]
}

En cas d'erreur

{
  "status": "error",
  "message": "Paramètre manquant ou invalide."
}

Exemples

← Retour à l'accueil