Check eligibility

Read-only eligibility breakdown for a site and its assets. Returns the list of propositions the site can enrol in, along with per-asset eligibility detail.

GET /entities/site/{site_id}/eligibility

Get Site Eligibility

cURL

curl --request GET \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site_properties": {
    "is_half_hourly_settled": false,
    "has_meter_consent": true
  },
  "eligible_propositions": [],
  "assets": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id · string<uuid> · required

Response

200

application/json

Successful Response

Eligibility detail for a site's proposition eligibility check.

site_id · string<uuid> · required

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

site_properties · Site Properties · object · required

Site-level properties relevant to eligibility evaluation.

Show child attributes

Example:

{
  "is_half_hourly_settled": false,
  "has_meter_consent": true
}

eligible_propositions · enum<string>[]

Available options: limited_pause, full_asset_schedule_control

assets · AssetEligibilityDetail · object[]

Show child attributes