GET /sites/{siteId}/prices

Changed on Feb 19, 2024

Returns all the prices between the start and end dates

Request

Base URL
https://api.amber.com.au/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/amberelectric/apis/amber-electric-public-api/docs/sites/:siteId/prices/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteIdstring required

ID of the site you are fetching prices for. Can be found using the /sites endpoint

Query parameters

startDatestring date

Return all prices for each interval on and after this day. Defaults to today.

endDatestring date

Return all prices for each interval on and before this day. Defaults to today.

resolution5 | 30

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

Response

A list of priced intervals<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.

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

Changes

Feb 19, 20248adde3b15a39 Revision changes
- info
  api operation id getPrices was added
Feb 19, 2024807291d1a356 Revision changes
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  removed the required property /////// from the response with the status
- breaking
  removed the required property /////// from the response with the status
- breaking
  removed the required property /////// from the response with the status
- breaking
  removed the required property /////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- warning
  removed the optional property ////////// from the response with the status
- info
  added to the ////// response property allOf list for the response status
- info
  added to the ////// response property allOf list for the response status
- info
  added to the ///////// response property allOf list for the response status
- info
  added to the ///////// response property allOf list for the response status
- info
  added to the ///////// response property allOf list for the response status

Operation history (10 revisions)