Retrieve a licensed Joule dataset using a bearer token at the authenticated Joule API URL.
Retrieve a licensed Joule dataset from the Joule API with a bearer token.
1. Request a bearer token
Send a POST request to https://delta-portal-webapp-prd-uks-app.azurewebsites.net/external-api/auth/token with your email address and API key:
{
"email": "{{email}}",
"apiKey": "{{apiKey}}"
}Use the bearer token returned by this request to authorize access to datasets covered by your API licence.
2. Request a dataset
Send a GET request to:
https://delta-portal-webapp-prd-uks-app.azurewebsites.net/joule/authenticated/{dataset}Replace {dataset} with a Dataset ID and include your token as a bearer token in the request authorization header.
The Joule API returns full datasets from LCP Delta's Joule database in JSON format. These datasets underpin many of the research products available on LCP Delta's Subscriber Portal. The response is an array of flat objects, each corresponding to a row in the dataset.
Dataset IDs
| Dataset | Dataset ID |
|---|---|
| EV Chargepoint Sales Forecast | EVChargingSalesForecast |
| EV Sales Forecast | EVSalesForecast |
| Solar PV Sales Forecast | SolarPVSalesForecast |
| Heating Sales Forecast | HeatSalesForecast |