Get Started with the Joule API

Upon subscribing to the Joule API, you will be granted API licenses on your Subscriber Portal account providing access to the agreed datasets.

To interact with the Joule API you can use tools like Postman, or follow the pattern outlined in the below examples:

import requests
from requests.auth import HTTPBasicAuth
import json

url = 'https://delta-jouleapi-prd-uks-func.azurewebsites.net/api/joule/{dataset}'
response = requests.get(url, auth=HTTPBasicAuth('{username}','{password}'))

data = response.json()
print(json.dumps(data, indent = 4))

HttpClient httpClient = new();

httpClient.BaseAddress = new Uri(@"https://delta-jouleapi-prd-uks-func.azurewebsites.net");
byte[] authToken = Encoding.ASCII.GetBytes("{username}:{password}");
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(authToken));
HttpResponseMessage result = await httpClient.GetAsync("/api/joule/{dataset}");

string contents = await result.Content.ReadAsStringAsync();

curl -X GET "https://delta-jouleapi-prd-uks-func.azurewebsites.net/api/joule/{dataset}" \
    -H "Authorization: Basic $(echo -n '{username}:{password}' | base64)" \
    -H "Content-Type: application/json" \
    -H "cache-control: no-cache"

Your username and password will be the same as for the Subscriber Portal. The dataset specified in the URL should match one of the Dataset IDs specified by the API. See the API Reference for more details.