Documentation API

Documentation ATerraData API

Accédez aux données environnementales en France via notre API REST simple et complète.

Introduction

L'API ATerraData vous permet d'accéder aux données environnementales en France via 7 modules : risques, urbanisme, nature, géographie, réseaux de chaleur, piézométrie et énergie.

Base URL

https://api.aterradata.com

Authentification

Toutes les requêtes API nécessitent une clé API valide passée via le header X-API-Key.

curl -H "X-API-Key: votre_cle_api" \ https://api.aterradata.com/api/v1/risks?address=Paris
⚠️ Gardez votre clé API secrète et ne la partagez jamais publiquement.

Endpoints Principaux

GET /api/v1/property-analysis

Analyse complète multi-modules d'une propriété (endpoint unifié recommandé).

Paramètres

Paramètre Type Requis Description
address string Non* Adresse complète en France
lat float Non* Latitude (entre -90 et 90)
lon float Non* Longitude (entre -180 et 180)
modules string Non Modules demandés (ex: risks,urban,nature)

* Soit address, soit lat + lon est requis

Modules disponibles (selon plan)

  • risks - Risques environnementaux (Géorisques)
  • urban - Urbanisme (PLU + Cadastre)
  • nature - Espaces naturels protégés
  • geo - Découpage administratif
  • chaleur - Réseaux de chaleur urbaine
  • piezo - Piézométrie (nappes phréatiques)
  • energy - Consommation énergétique

Exemple de requête

curl -H "X-API-Key: sk_live_..." \ "https://api.aterradata.com/api/v1/property-analysis?address=15+rue+de+la+Paix+Paris&modules=risks,urban"
GET /api/v1/risks

Récupère les risques environnementaux pour une adresse ou des coordonnées GPS.

Paramètres

Paramètre Type Requis Description
address string Non* Adresse complète en France
lat float Non* Latitude (entre -90 et 90)
lon float Non* Longitude (entre -180 et 180)

* Soit address, soit lat + lon est requis

Exemple de requête

curl -H "X-API-Key: sk_live_..." \ "https://api.aterradata.com/api/v1/risks?address=15+rue+de+la+Paix+Paris"

Exemple de réponse (200 OK)

{ "address_queried": "15 rue de la Paix, 75002 Paris", "coordinates": { "lat": 48.8698, "lon": 2.3308 }, "risk_summary": { "inondation": { "level": "nul", "description": "Aucun risque d'inondation identifié" }, "retrait_gonflement_argiles": { "level": "faible", "description": "Aléa faible" }, "radon": { "level": "faible", "description": "Potentiel radon faible" }, "seisme": { "level": "tres_faible", "zone": 1 }, "pollution_sols": { "level": "nul" }, "sites_industriels_icpe": { "level": "nul" } }, "data_source": "georisques", "last_updated": "2025-01-18T14:30:00Z" }
GET /widget/health

Vérifie la santé du service widget (aucune authentification requise).

Exemple de réponse

{ "status": "healthy", "service": "Widget Service", "widget_js_available": true }

Gestion d'erreurs

L'API utilise les codes HTTP standards :

Code Signification Description
200 OK Requête réussie
400 Bad Request Paramètres manquants ou invalides
401 Unauthorized Clé API manquante ou invalide
429 Too Many Requests Limite de requêtes dépassée
500 Internal Server Error Erreur serveur

Format d'erreur

{ "detail": "Message d'erreur descriptif" }

Rate Limits

⚡ Important : Les quotas sont unifiés (API + Widget). Que vous utilisiez l'API, le Widget, ou les deux, vous consommez le même quota mensuel.

Plan Gratuit - 0€/mois

  • 50 requêtes / mois (API + Widget combinés)
  • 1 clé API
  • 1 module API (Risks)
  • Widget (Risks uniquement)
  • Plugin QGIS (7 modules)

Plan Standard - 29€/mois

  • 1 000 requêtes / mois (API + Widget combinés)
  • 1 module API (Risks)
  • Widget (Risks uniquement)
  • Plugin QGIS (7 modules)

Plan Business - 99€/mois

  • 10 000 requêtes / mois (API + Widget combinés)
  • 6 modules API (Risks, Urban, Geo, Chaleur, Piezo, Energy)
  • Widget (Risks uniquement)
  • Plugin QGIS (7 modules)
  • Support prioritaire

Plan Premium - 249€/mois

  • 100 000 requêtes / mois (API + Widget combinés)
  • 7 modules API (Tous modules incluant Nature)
  • Widget (Risks uniquement)
  • Plugin QGIS (7 modules)
  • Support prioritaire dédié

💡 Besoin de plus ? Consultez nos plans tarifaires pour tous les détails.

Exemples

JavaScript (Fetch API)

const response = await fetch( 'https://api.aterradata.com/api/v1/risks?address=Paris', { headers: { 'X-API-Key': 'votre_cle_api' } } ); const data = await response.json(); console.log(data.risk_summary);

Python (requests)

import requests headers = {'X-API-Key': 'votre_cle_api'} params = {'address': 'Paris, France'} response = requests.get( 'https://api.aterradata.com/api/v1/risks', headers=headers, params=params ) data = response.json() print(data['risk_summary'])

cURL

curl -X GET \ -H "X-API-Key: votre_cle_api" \ "https://api.aterradata.com/api/v1/risks?lat=48.8566&lon=2.3522"

Besoin d'aide ?

Contactez notre équipe pour toute question.

Contacter le support Swagger API