API REST · Cabinets de courtage énergie
API de calcul tarifaire gaz et électricité
L'API REST d'Energy Data Platform expose à votre CRM ou à vos outils internes le moteur de calcul utilisé dans l'interface EDP : coûts d'acheminement gaz et électricité à partir des barèmes CRE, calcul en lot, suivi du portefeuille de contrats. Elle est versionnée sous /api/v1/ et documentée publiquement au format OpenAPI.
En bref
- Calcul unitaire : un appel
POST /api/v1/simulator/calculate/renvoie le calcul d'un site gaz (PITD, LI, PIC) ou électricité (TURPE, TURPE_HTB). - Authentification : une clé API par organisation, transmise dans l'en-tête HTTP
X-API-Key. - Limite : 60 requêtes par minute et par clé.
- Documentation : Swagger public sur api.energydataplatform.fr/api/docs/.
- Offre : l'API REST figure dans l'offre Enterprise de la grille tarifaire.
Cas d'usage pour un cabinet de courtage
Intégration CRM
À la création ou à la mise à jour d'un dossier client, votre CRM appelle l'endpoint de calcul avec les caractéristiques du site (point de livraison, tarif, profil, consommation annuelle de référence) et enregistre le résultat dans la fiche. Le consultant n'a plus à ressaisir le site dans l'interface EDP.
Chiffrage en lot
L'endpoint /api/v1/batch-calc/jobs/ accepte un CSV de PCE et PRM (colonnes obligatoires : siret, pdl_pce, type, tarif ; optionnelles : profil, car, mois), jusqu'à 200 lignes par envoi. La réponse indique le statut du lot et le nombre de lignes calculées ou en erreur.
Audit rétroactif
Le champ dateEffetMonth (AAAA-MM) fait calculer le site avec le barème en vigueur sur le mois demandé : utile pour recalculer une facture passée dans le cadre d'un contrôle de factures.
Tableau de bord portefeuille
L'endpoint /api/v1/contracts/monitoring/ renvoie les indicateurs agrégés des contrats en cours de votre organisation et les alertes d'échéance, pour alimenter un tableau de bord interne.
Endpoints disponibles
L'API v1 comprend six endpoints, tous authentifiés par clé API. La liste ci-dessous correspond à la documentation Swagger publique.
POST /api/v1/simulator/calculate/
Calcul tarifaire d'un site : gaz (PITD, LI, PIC) ou électricité (TURPE, TURPE_HTB). Réponse structurée uniquement, sans PDF ni session.
POST /api/v1/batch-calc/jobs/
Calcul en lot à partir d'un CSV (fichier multipart « file » ou texte « csv » dans un corps JSON), jusqu'à 200 lignes par envoi. Traitement synchrone.
GET /api/v1/batch-calc/jobs/{job_id}/
Statut d'un lot (queued, running, done, failed) et nombre de lignes traitées ou en erreur. Lot introuvable s'il n'appartient pas à l'organisation de la clé.
POST /api/v1/brokerage/compare/
Comparaison des offres fournisseurs référencées dans EDP pour un profil (type d'énergie + consommation annuelle en MWh, ou profil énergétique existant). Économie calculée si le coût annuel actuel est fourni.
GET /api/v1/contracts/monitoring/
Indicateurs du portefeuille de contrats en cours de l'organisation : nombre, coût et consommation annuels, contrats arrivant à échéance sous 90 jours, alertes d'échéance à 180 jours.
GET /api/v1/usage/
Consommation de la clé : limite par minute, appels de la minute en cours, appels par endpoint sur 30 jours, date du dernier appel.
Authentification et limites de débit
- Chaque requête porte l'en-tête
X-API-Key. Sans clé, ou avec une clé inconnue, révoquée ou expirée, l'API répond 401. Les endpoints v1 n'acceptent pas d'autre mode d'authentification. - Les clés se gèrent en libre-service depuis la page « Clés API » de l'espace EDP, par les propriétaires et administrateurs d'une organisation cabinet de courtage : nom, description, date d'expiration optionnelle, révocation, date et adresse IP du dernier appel.
- La clé complète n'est affichée qu'une fois, à sa création. EDP ne stocke que son empreinte SHA-256. Un e-mail est envoyé au créateur de la clé à sa création et à sa révocation.
- Jusqu'à 5 clés actives par organisation sur l'offre Enterprise, par exemple une par environnement (recette, production).
- Limite de 60 requêtes par minute et par clé. Au-delà : réponse 429 avec l'en-tête
Retry-After. Les en-têtesX-RateLimit-Limit,X-RateLimit-RemainingetX-RateLimit-Resetaccompagnent les réponses. - Les données renvoyées sont limitées à l'organisation propriétaire de la clé (contrats, lots, profils énergétiques).
Exemple : calcul d'un site gaz PITD
Requête avec les champs acceptés par l'endpoint : point de livraison, code PITD du site, tarif, profil et consommation annuelle de référence (car, en MWh/an). Le champ dateEffetMonth est optionnel. L'en-tête Content-Type: application/json est obligatoire.
curl -X POST https://api.energydataplatform.fr/api/v1/simulator/calculate/ \
-H "X-API-Key: $EDP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pointDeReseau": "PITD",
"code": "<code PITD du site>",
"tarif": "T2",
"profil": "P014",
"car": 150,
"dateEffetMonth": "2026-01"
}'Structure de la réponse (extrait, valeurs omises) :
{
"organisation": "slug-de-votre-cabinet",
"pointDeReseau": "PITD",
"result": {
"abonnementA": ...,
"termeProportionnelA": ...,
"totalCtaA": ...,
"ticgnA": ...,
"totalA": ...,
"miseAJourTarifaireDu": "...",
...
}
}Pour un site PITD, totalA est le coût annuel d'acheminement et de taxes, hors part fourniture et hors TVA. Le contenu de result varie selon le point de livraison. Un champ warnings peut signaler une combinaison tarif / profil inhabituelle, sans bloquer le calcul.
Quelle offre inclut l'API ?
D'après la grille tarifaire publique, l'API REST fait partie de l'offre Enterprise. La génération des clés est réservée aux propriétaires et administrateurs d'une organisation déclarée comme cabinet de courtage.
Limites actuelles
- Calcul en lot : 200 lignes maximum par envoi via l'API et fichier de 5 Mo maximum. Au-delà, découpez le fichier.
- Traitement synchrone : la réponse revient une fois le lot calculé.
- Le moteur calcule les composantes régulées (acheminement, CTA et, selon le point de livraison, taxes). Le prix de fourniture négocié n'est pas calculé.
- L'endpoint de comparaison fournisseurs renvoie les offres référencées dans EDP ; le comparateur fournisseurs est annoncé « à venir » dans la grille tarifaire.
- Pas de webhook : votre outil interroge l'API à son initiative.
Questions fréquentes sur l'API
Comment obtenir une clé API EDP ?
Un propriétaire ou administrateur d'une organisation cabinet de courtage génère la clé depuis la page « Clés API » de son espace EDP. La clé complète (format edp_ suivi de 32 caractères hexadécimaux) n'est affichée qu'une seule fois : EDP n'en conserve qu'une empreinte SHA-256. Sur l'offre Enterprise, une organisation peut avoir jusqu'à 5 clés actives.
Quelle est la limite de requêtes de l'API ?
60 requêtes par minute et par clé. Au-delà, l'API répond 429 avec un en-tête Retry-After. Chaque réponse porte les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset. L'endpoint /api/v1/usage/ ne renvoie aucun quota mensuel (champ monthly_quota à null).
Où se trouve la documentation de l'API ?
La documentation Swagger est publique, sans compte, sur api.energydataplatform.fr/api/docs/. La même description est disponible en ReDoc (/api/redoc/) et au format OpenAPI 3 (/api/schema/).
Peut-on calculer un tarif sur un barème passé ?
Oui. Le champ optionnel dateEffetMonth (format AAAA-MM) de l'endpoint /api/v1/simulator/calculate/ sélectionne le barème en vigueur sur le mois demandé, ce qui sert au recalcul de factures dans un audit rétroactif. Sans ce champ, le barème en vigueur est utilisé.
Quelle offre EDP inclut l'API REST ?
D'après la grille publique des tarifs, l'API REST fait partie de l'offre Enterprise. La gestion des clés est réservée aux propriétaires et administrateurs de l'organisation cabinet.
Autres questions sur EDP : FAQ complète.
Brancher EDP sur les outils de votre cabinet
Consultez les formules pour vérifier l'accès à l'API, ou contactez-nous pour préparer votre intégration.