API.doc

Bienvenue sur l’API adresse IMOPE

Vous pouvez à présent intégrer des données IMOPE directement dans vos applications. Notre service d’API permet de récupérer les données fiabilisées à l’échelle des adresses à partir de quatre points d’entrée :

  • Une recherche sémantique “15 rue paix 42000”
  • Un identifiant BAN
  • Un identifiant cadastral
  • Une géolocalisation par coordonnées GPS

Comment accéder à l’API ?

Pour interroger notre API, vous devez d’abord générer votre clé d’accès depuis la page “Ma clé d’API”.

La clé obtenue devra être placée dans les paramètres query-string:

?key={YOUR_API_KEY}

Ou bien dans les headers Authorization de vos requêtes :

Authorization: Bearer {YOUR_API_KEY}

Comment interroger l’API ?

En deux temps :

    1. En interrogeant le endpoint /geocoder afin de collecter les adresses IMOPE qui vous intéressent. Cette requête accepte différents paramètres de recherche : du texte, un identifiant de parcelle, un identifiant BAN ou encore une géolocalisation par coordonnées GPS.



Les endpoint de l’API sont documentés ici : Swagger API ouverte

Quelles limites ?

L’API est soumise aux restrictions suivantes :

  • jusqu’à 100 000 interrogations / an
  • 150 appels par minute par IP

Par “interrogation”, nous entendons : identifiant adresse appelé sur le endpoint /dashboard et ayant retourné un résultat.

Par exemple : si vous appelez 10 identifiants adresse dans une requête et que 8 d’entre eux seulement retournent un résultat, nous décomptons 8 appels.

Les endpoint /attributes et /geocoder ne sont pas décomptés.

Pour aller plus loin

Si vous souhaitez obtenir un accès au catalogue complet des attributs, aux données enrichies, aux prédictions des données manquantes et à un nombre de requêtes plus important, nous vous invitons à consulter notre offre API+.

Vous avez été déconnecté.

  • Par une session concurrente (sur un autre navigateur ou par une autre personne)
  • Le service est en cours de maintenance.