AXaxle
3. Sites

Get Sites

Changed on

Retrieve sites, optionally filtering by MPAN or postcode.

Returns a page of sites with the total count and the requested subset of site records. Use the limit and offset parameters to navigate through pages of results.

get/entities/site

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/site
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Query parameters

mpanstring

Filter sites by MPAN

postcodestring

Filter sites by postcode

limitinteger

Maximum number of sites to return (1-5000)

offsetinteger

Number of sites to skip for pagination

Response

Successful Response

total_num_sitesinteger required

Total number of sites available

total_num_pagesinteger required

Total number of pages available

page_numberinteger required

Current page number (1-based)

Changes

  • b0b07b1dbf12Revision changes
    • warning

      added the new price_curve enum value to the /// response property for the response status