GET /sites — amber-electric-public-api

Return all sites linked to your account

get/sites

Response

A list of sites.

idstring required

Unique Site Identifier

nmistring required

National Metering Identifier (NMI) for the site

networkstring required

The name of the site's network

status'pending' | 'active' | 'closed' required

Site status.

Pending sites are still in the process of being transferred. Note: We only include sites that have correct address details. If you expect to see a site, but don't, you may need to contact info@amber.com.au to check that the address is correct.

Active sites are ones that we actively supply electricity to.

Closed sites are old sites that we no longer supply.

activeFromstring

Date the site became active. This date will be in the future for pending sites. It may also be undefined, though if it is, contact info@amber.com.au - there may be an issue with your address. Formatted as a ISO 8601 date when present.

closedOnstring

Date the site closed. Undefined if the site is pending or active. Formatted as a ISO 8601 date when present.

Example response

[
  {
    "id": "01F5A5CRKMZ5BCX9P1S4V990AM",
    "nmi": "3052282872",
    "channels": [
      {
        "identifier": "E1",
        "type": "general",
        "tariff": "A100"
      }
    ],
    "network": "Jemena",
    "status": "active",
    "activeFrom": "2022-01-01",
    "closedOn": "2022-05-01"
  }
]

Changes

Changed in 7 of the 28 revisions of this API.15623

Feb 19, 20248adde3b15a391See the full diff
- ○
  api operation id getSites was added
  api-operation-id-added
Feb 16, 2024171418be692b52See the full diff
- ▲
  removed the required property channels from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property network from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property nmi from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property activeFrom from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property closedOn from the response with the 200 status
  response-optional-property-removed
Feb 16, 2024ecefb836e7577See the full diff
- ○
  added the optional property activeFrom to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property closedOn to the response with the 200 status
  response-optional-property-added
- ○
  added the required property channels to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
- ○
  added the required property network to the response with the 200 status
  response-required-property-added
- ○
  added the required property nmi to the response with the 200 status
  response-required-property-added
- ○
  added the required property status to the response with the 200 status
  response-required-property-added
Feb 16, 2024d5a4727e69d552See the full diff
- ▲
  removed the required property channels from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property network from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property nmi from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property activeFrom from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property closedOn from the response with the 200 status
  response-optional-property-removed
Feb 16, 20245e9ca1a2749f7See the full diff
- ○
  added the optional property activeFrom to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property closedOn to the response with the 200 status
  response-optional-property-added
- ○
  added the required property channels to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
- ○
  added the required property network to the response with the 200 status
  response-required-property-added
- ○
  added the required property nmi to the response with the 200 status
  response-required-property-added
- ○
  added the required property status to the response with the 200 status
  response-required-property-added
Feb 16, 2024554734ed013352See the full diff
- ▲
  removed the required property channels from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property network from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property nmi from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property activeFrom from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property closedOn from the response with the 200 status
  response-optional-property-removed
Feb 16, 20248c2cf08d700d8See the full diff
- ○
  api operation id getSites removed and replaced with
  api-operation-id-removed
- ○
  added the optional property activeFrom to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property closedOn to the response with the 200 status
  response-optional-property-added
- ○
  added the required property channels to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
- ○
  added the required property network to the response with the 200 status
  response-required-property-added
- ○
  added the required property nmi to the response with the 200 status
  response-required-property-added
- ○
  added the required property status to the response with the 200 status
  response-required-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history