GET /sites/:siteId/usage — amber-electric-public-api

Returns all usage data between the start and end dates. The API can only return 90-days worth of data.

get/sites/{siteId}/usage

Path parameters

siteIdstring required

ID of the site you are fetching usage for. Can be found using the /sites enpoint

Query parameters

startDatestring date required

Return all usage for each interval on and after this day.

endDatestring date required

Return all usage for each interval on and before this day.

resolution30

Specify the required interval duration resolution. Valid options: 30. Default: 30

Response

Usage for the requested period.<br><br>Return Order: General > Controlled Load > Feed In.<br><br>NOTE: If a channel is added or removed the index offset will change. It is best to filter or group the array by channel type.

duration5 | 15 | 30 required

Length of the interval in minutes.

spotPerKwhnumber required

NEM spot price (c/kWh). This is the price generators get paid to generate electricity, and what drives the variable component of your perKwh price - includes GST

perKwhnumber required

Number of cents you will pay per kilowatt-hour (c/kWh) - includes GST

datestring date required

Date the interval belongs to (in NEM time). This may be different to the date component of nemTime, as the last interval of the day ends at 12:00 the following day. Formatted as a ISO 8601 date

nemTimestring date-time required

The interval's NEM time. This represents the time at the end of the interval UTC+10. Formatted as a ISO 8601 time

startTimestring date-time required

Start time of the interval in UTC. Formatted as a ISO 8601 time

endTimestring date-time required

End time of the interval in UTC. Formatted as a ISO 8601 time

renewablesnumber required

Percentage of renewables in the grid

channelType'general' | 'controlledLoad' | 'feedIn' required

Meter channel type

spikeStatus'none' | 'potential' | 'spike' required

Indicates whether this interval will potentially spike, or is currently in a spike state

Describes the current price. Gives you an indication of how cheap the price is in relation to the average VMO and DMO. Note: Negative is no longer used. It has been replaced with extremelyLow.

type'Usage' required

channelIdentifierstring required

Meter channel identifier

kwhnumber required

Number of kWh you consumed or generated. Generated numbers will be negative

quality'estimated' | 'billable' required

If the metering company has had trouble contacting your meter, they may make an estimate of your usage for that period. Billable data is data that will appear on your bill.

costnumber required

The total cost of your consumption or generation for this period - includes GST

Example response

[
  {
    "spotPerKwh": 6.12,
    "perKwh": 24.33,
    "date": "2021-05-05",
    "nemTime": "2021-05-06T12:30:00+10:00",
    "startTime": "2021-05-05T02:00:01Z",
    "endTime": "2021-05-05T02:30:00Z",
    "renewables": 45,
    "channelType": "general",
    "channelIdentifier": "E1"
  }
]

Changes

Changed in 10 of the 28 revisions of this API.4823

Feb 19, 20248adde3b15a391See the full diff
- ○
  api operation id getUsage was added
  api-operation-id-added
Feb 19, 2024807291d1a3561See the full diff
- ○
  the response property // became required for the status
  response-property-became-required
Feb 19, 2024744a2629bc70241See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added to the ///// response property allOf list for the response status
  response-property-all-of-added
Feb 19, 2024ccc4db00804016See the full diff
- ▲
  the ///// response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  removed from the ///// response property allOf list for the response status
  response-property-all-of-removed
- ○
  the response property // became required for the status
  response-property-became-required
Feb 19, 202474933103dd47141See the full diff
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added to the ///// response property allOf list for the response status
  response-property-all-of-added
Feb 16, 2024ecefb836e7572See the full diff
- ○
  for the query request parameter endDate, the type was generalized from no type to string, and format from date-time to date
  request-parameter-type-generalized
- ○
  for the query request parameter startDate, the type was generalized from no type to string
  request-parameter-type-generalized
Feb 16, 20245943d9176aaa2See the full diff
- ○
  for the query request parameter endDate, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  for the query request parameter startDate, the type was generalized from string to no type
  request-parameter-type-generalized
Feb 16, 202445e3397ba8e02See the full diff
- ○
  for the query request parameter endDate, the type was generalized from no type to string
  request-parameter-type-generalized
- ○
  for the query request parameter startDate, the type was generalized from no type to string
  request-parameter-type-generalized
Feb 16, 2024b22d50d1e47b2See the full diff
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
- ○
  removed subschema #1 from the response property allOf list for the response status
  response-property-all-of-removed
Feb 16, 20248c2cf08d700d5See the full diff
- ○
  api operation id getUsage removed and replaced with
  api-operation-id-removed
- ○
  for the query request parameter endDate, the type was generalized from string to no type, and format from date to date-time
  request-parameter-type-generalized
- ○
  for the query request parameter startDate, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  added subschema #1 subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history