GET
/
entities
/
site
curl --request GET \
  --url https://api-sandbox.axle.energy/entities/site \
  --header 'Authorization: Bearer <token>'
{
  "sites": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mpan": "<string>",
      "postcode": "<string>",
      "address": "<string>",
      "asset_ids": [],
      "markets": [
        "cm"
      ],
      "tariff": {
        "tariff_type": "single_rate",
        "tariff_cheap_start_time": "<string>",
        "tariff_cheap_end_time": "<string>"
      }
    }
  ],
  "total_num_sites": 123,
  "total_num_pages": 123,
  "page_number": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

mpan
string

Filter sites by MPAN

postcode
string

Filter sites by postcode

limit
integer
default:10

Maximum number of sites to return (1-5000)

Required range: 1 <= x <= 5000
offset
integer
default:0

Number of sites to skip for pagination

Required range: x >= 0

Response

200
application/json

Successful Response

Paginated response for site listings.