How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EDF Energy V1 API

The v1 API from EDF Energy — 23 operation(s) for v1.

EDF Energy V1 API is one of 9 APIs that EDF Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 23 operations across 23 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.edfgb-kraken.energy/v1/.

23 operations 23 paths 57 schemas 15 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.edfgb-kraken.energy/v1/graphql/
Authentication
HTTP Basic, HTTP Basic, API Key, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 5

EDF Energy V1 API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (AccountUserAPIKeyAuthentication). It accepts HTTP basic authentication (AffiliateAuthentication). An API key is passed in the header as Authorization (DRFKrakenTokenAuthentication). An API key is passed in the header as Authorization (KeyAuthentication). It accepts HTTP basic authentication (PartnerUserOnlyAuthentication).

  • AccountUserAPIKeyAuthentication — Token-based authentication where token is passed as the username for basic auth
  • AffiliateAuthentication — Basic authentication for affiliate organisations
  • DRFKrakenTokenAuthentication — JWT-based authentication
  • KeyAuthentication — Token-based authentication with required prefix "Token "
  • PartnerUserOnlyAuthentication — Basic authentication for partner organisations

Paths & Operations 23

Across 23 paths, the API surfaces 23 operations — 15 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

v1 23
POST
/v1/accounts/
WARNING: This endpoint is only available to partner organisations.
Create an account body → 201202400
POST
/v1/accounts/{account_number}/tariff-renewal/
This end-point allows a new agreement to be created for an existing account. It is restricted to business accounts. WARNING: This endpoint is only available to partner organisations.
Renew a business tariff 1 param body → 201400404401403500
GET
/v1/electricity-meter-points/{mpan}/
Retrieve the details of a meter-point. This endpoint can be used to get the GSP of a given meter-point.
Get Electricity Meter Point 1 param → 200
GET
/v1/electricity-meter-points/{mpan}/meters/{serial_number}/consumption/
Return a list of consumption values (in kWh) for half-hour periods for a given meter-point and meter. WARNING: Half-hourly consumption data is only available for smart meters. Requests for consumptio…
List consumption for an electricity meter 8 params → 200
GET
/v1/gas-meter-points/{mprn}/meters/{serial_number}/consumption/
Return a list of consumption values (in kWh for SMETS1 and in m^3 for SMETS2) for half-hour periods for a given gas meter-point and meter. WARNING: Half-hourly consumption data is only available for…
List consumption for a gas meter 8 params → 200
GET
/v1/industry/grid-supply-points/
Return a list of GSP objects, optionally filtered by postcode. If we’re unable to map the passed postcode to a GSP, an empty list will be returned
List Industry Grid Supply Points 2 params → 200
POST
/v1/payment-intents/confirm/
Create Stripe charge using Stripe's PaymentIntent model and Elements (js) which automatically applies for authentication exemptions and performs authentication. The intent will be confirm using the S…
Confirm a Stripe payment intent body → 200400
POST
/v1/payment-intents/create/
Create a Stripe payment using Stripe's PaymentIntent and Elements (js) which automatically applies for authentication exemptions and performs authentication. Handles both immediate and scheduled Stri…
Create a Stripe payment intent body → 200400
POST
/v1/payment-intents/fail/
Handle a failure when creating a Stripe charge using Stripe's PaymentIntent model and Elements (js) which automatically applies for authentication exemptions and performs authentication. Docs: https:…
Mark a Stripe payment intent as failed body → 200
GET
/v1/products/
Return a list of energy products. By default, results will be public energy products but if the authenticated organisations will also see products available to their organisation.
List Products 9 params → 200
GET
/v1/products/{product_code}/
Product 1 param → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/day-unit-rates/
Electricity Tariff Day Unit Rates 6 params → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/ev-device-off-peak-unit-rates/
Electricity Tariff Ev Device Off Peak Unit Rates 6 params → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/ev-device-peak-unit-rates/
Electricity Tariff Ev Device Peak Unit Rates 6 params → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/night-unit-rates/
Electricity Tariff Night Unit Rates 6 params → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/standard-unit-rates/
Electricity Tariff Standard Unit Rates 6 params → 200
GET
/v1/products/{product_code}/electricity-tariffs/{tariff_code}/standing-charges/
Electricity Tariff Standing Charges 6 params → 200
GET
/v1/products/{product_code}/gas-tariffs/{tariff_code}/standard-unit-rates/
Gas Tariff Standard Unit Rates 6 params → 200
GET
/v1/products/{product_code}/gas-tariffs/{tariff_code}/standing-charges/
Gas Tariff Standing Charges 6 params → 200
POST
/v1/quotes/
At least one electricity or gas meter-point must be included. A maximum of one electricity and one gas meter-point can be included at this time. For all meter-points, at least one of gsp or postcode…
Create a quote body → 201400
POST
/v1/quotes/{code}/products/{product_id}/
Use this endpoint after quote creation to send a quote summary email to the specified recipients if they wish to enact the quote at a later time. A quote share record is saved to the database for eac…
Share a quote via email 2 params body → 404400204
POST
/v1/voice/twilio/enqueue-audio/
Twilio Enqueue Audio → 200
GET
/v1/voice/twilio/voice-announcement/
Return TwiML that speaks a translated message to the caller. Query parameters: - translationkey: required if announcement is not provided — the FTL message identifier to translate. - announcement: re…
Voice Announcement → 200

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are Create (28 properties), Product (22 properties), ElectricityMeterPoint (21 properties), Products (16 properties). Each schema is shown below with its type and property counts.

BespokeTariffRates
object
3 properties
Consumption
object
3 properties 3 required
_BespokeRegisterRate
object
4 properties 1 required
ProprietorAddress
object
6 properties 2 required
Product
object
22 properties 15 required
Deposit
object
3 properties
SampleConsumption
object
4 properties 4 required
PaymentErrorResponse
object
1 property 1 required
PaginatedHistoricalChargeList
object
4 properties 2 required
BespokePPSTariffRates
object
4 properties 1 required
GasTariff
object
13 properties 13 required
PSR
object
1 property
Link
object
3 properties 3 required
ConfirmStripePaymentIntent
object
Serializer for confirming Stripe payments using Payment Intents and Stripe JS Elements.
5 properties 3 required
BusinessTariffRenewal
object
1 property 1 required
AgreementsCreated
object
2 properties 2 required
ErrorResponse
object
1 property 1 required
CreateQuoteError
object
5 properties
SuccessResponse
object
1 property 1 required
PaymentIntentCreated
object
3 properties 3 required
Business
object
10 properties 4 required
Proprietor
object
6 properties 3 required
FailedStripePaymentIntent
object
Serializer for handling failed Stripe payments using Payment Intents and Stripe JS Elements.
4 properties 2 required
PaginatedConsumptionList
object
4 properties 2 required
_BespokeTariffRate
object
4 properties 2 required
ValidationErrors
object
1 property 1 required
Payment
object
6 properties 1 required
_Agreement
object
6 properties 3 required
_Commission
object
5 properties 2 required
Installation
object
5 properties 3 required
ValidationOrDomainError
object
1 property 1 required
PaginatedProductsList
object
4 properties 2 required
Agreement
object
4 properties 3 required
SampleQuotes
object
4 properties 4 required
HistoricalCharge
object
5 properties 5 required
CreditScoreData
object
2 properties
StandardElectricityTariff
object
13 properties 13 required
FourRateEvElectricityTariff
object
11 properties 11 required
CreateStripePaymentIntent
object
Serializer for Stripe payments creation using Payment Intents and Stripe JS Elements.
6 properties 3 required
Products
object
16 properties 8 required
Eco7ElectricityTariff
object
15 properties 15 required
QuoteCreated
object
3 properties 3 required
BespokeElectricityUnitRate
object
3 properties 1 required
GasMeterPoint
object
16 properties 2 required
PaymentIntentConfirmed
object
1 property 1 required
Metadata
object
2 properties 2 required
EmailQuote
object
3 properties 1 required
Quote
object
1 property 1 required
PaginatedGridSupplyPointList
object
4 properties 2 required
BillingOptions
object
3 properties
Address
object
7 properties 2 required
ElectricityMeterPoint
object
21 properties 1 required
Create
object
Serializer to create an account via a REST API.
28 properties 6 required
ExportDetails
object
5 properties
GridSupplyPoint
object
1 property 1 required
Affiliate
object
This serializer is used to allow affiliates to pass a signup reward code when creating accounts which later will then give credit to the accounts once their pa…
3 properties
User
object
12 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edf-energy-v1-api-openapi.yml Raw ↑

Other APIs EDF Energy publishes across the network.

EDF Kraken GraphQL API
EDF Energy Account Import API
EDF Energy Data Import API
EDF Energy External Client Healthcheck API
EDF Energy External Events API
EDF Energy Post Account Import API
EDF Energy Query API
EDF Energy V2 API
Where this information came from

This is an independent, third-party profile of EDF Energy V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.