🌍ClimaScore

API ClimaScore

Documentation de l'API publique

Obtenez votre clé API

Créez un compte pro pour générer vos clés API et accéder à l'ensemble des endpoints.

Créer un compte pro

Authentification

Toutes les requêtes vers l'API nécessitent une clé d'API valide. Vous pouvez fournir votre clé de deux manières :

  • Via le paramètre de requête api_key
  • Via l'en-tête HTTP X-API-Key

Limites de débit

L'API est limitée à 30 requêtes par minute par clé d'API.

Les en-têtes de réponse incluent X-RateLimit-Remainingpour indiquer le nombre de requêtes restantes.

Endpoints

GET /api/v1/score

Calcule le score climatique pour une adresse donnée.

Paramètres :

  • address (requis) : Adresse à analyser
  • api_key (requis) : Votre clé d'API

Exemple :

GET /api/v1/score?address=10+rue+de+Rivoli+Paris&api_key=YOUR_API_KEY

GET /api/v1/score/[code_insee]

Calcule le score climatique pour une commune via son code INSEE.

Paramètres :

  • code_insee (path) : Code INSEE à 5 chiffres
  • api_key (requis) : Votre clé d'API

Exemple :

GET /api/v1/score/75056?api_key=YOUR_API_KEY

Format de réponse

Les réponses sont au format JSON :

{
  "address": "10 Rue de Rivoli 75001 Paris",
  "codeInsee": "75101",
  "grade": "B",
  "score": 1.45,
  "risks": [
    {
      "id": "inondation",
      "label": "Inondation",
      "level": 2,
      "weight": 0.25
    },
    {
      "id": "argiles",
      "label": "Retrait-gonflement des argiles",
      "level": 1,
      "weight": 0.2
    }
  ],
  "generatedAt": "2026-02-08T12:34:56.789Z"
}

Exemples de code

cURL

curl -X GET "https://climascore.vercel.app/api/v1/score?address=10+rue+de+Rivoli+Paris&api_key=YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript (fetch)

const apiKey = "YOUR_API_KEY";
const address = "10 rue de Rivoli Paris";

fetch(`https://climascore.vercel.app/api/v1/score?address=${encodeURIComponent(address)}&api_key=${apiKey}`)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error("Error:", error));

Python (requests)

import requests

api_key = "YOUR_API_KEY"
address = "10 rue de Rivoli Paris"

response = requests.get(
    "https://climascore.vercel.app/api/v1/score",
    params={"address": address, "api_key": api_key}
)

if response.status_code == 200:
    data = response.json()
    print(f"Grade: {data['grade']}, Score: {data['score']}")
else:
    print(f"Error: {response.status_code}")

Codes d'erreur

  • 400 - Paramètres manquants ou invalides
  • 401 - Clé d'API invalide ou manquante
  • 404 - Adresse introuvable
  • 429 - Limite de débit dépassée
  • 500 - Erreur serveur interne

Besoin d'aide ?

contact@climascore.frMéthodologie de scoring