Sign in

v1

latestOpenAPI 3.0.02026-07-1751732.9 KB

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"
  }
]