Search meters

Search for all electricity meters in the vicinity of a given postcode/ address.

This endpoint allows searching for meters by postcode and optionally by building identifier. For data protection and contractual reasons, meter details are returned in an encrypted format that can be used in subsequent API calls to retrieve the full meter information.

The search works in three steps:

1. Search for meters at the specified address using this endpoint
2. Ask the end-user to select the correct address from the list
3. Call the /meter/by-ref/{meter_ref} endpoint with the corresponding reference to get the full meter details

NB: This should not be used with procedural address matching; it is intended for end-user interaction only. For precise address matching, use the /meter/by-address endpoint instead, which will perform matching for you.

GET /meter/search

Search Meters

cURL

curl --request GET \
  --url https://api-sandbox.axle.energy/meter/search \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "ref": "<string>",
    "address": "<string>"
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

postcode · string · required

Postcode at which the requested meter is registered

building_identifier · string

House number or house/building name, e.g. '3', '10A', 'Flat 4', 'The Old Barn'

Response

200

application/json

List of meters matching the address; may be empty

ref · string · required

Encrypted reference to the meter that can be used in subsequent API calls

address · string · required

Full address where the meter is registered