---
title: "GET /sites/{siteId}/usage"
method: GET
path: "/sites/{siteId}/usage"
---

# GET /sites/{siteId}/usage

`GET /sites/{siteId}/usage`

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

## Path parameters

- `siteId` string, required

## Query parameters

- `startDate` string, date, required
- `endDate` string, date, required
- `resolution` 30

## Response `200`

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.

- Usage[]
  - `duration` 5 | 15 | 30, required — Length of the interval in minutes.
  - `spotPerKwh` number, 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
  - `perKwh` number, required — Number of cents you will pay per kilowatt-hour (c/kWh) - includes GST
  - `date` string, 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
  - `nemTime` string, 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
  - `startTime` string, date-time, required — Start time of the interval in UTC. Formatted as a ISO 8601 time
  - `endTime` string, date-time, required — End time of the interval in UTC. Formatted as a ISO 8601 time
  - `renewables` number, required — Percentage of renewables in the grid
  - `channelType` 'general' | 'controlledLoad' | 'feedIn', required — Meter channel type
  - `tariffInformation` TariffInformation — Information about how your tariff affects an interval
    - `period` 'offPeak' | 'shoulder' | 'solarSponge' | 'peak' — The Time of Use period that is currently active. Only available if the site in on a time of use tariff
    - `season` 'default' | 'summer' | 'autumn' | 'winter' | 'spring' | 'nonSummer' | 'holiday' | 'weekend' | 'weekendHoliday' | 'weekday' — The Time of Use season that is currently active. Only available if the site in on a time of use tariff
    - `block` number — The block that is currently active. Only available in the site in on a block tariff
    - `demandWindow` boolean — Is this interval currently in the demand window? Only available if the site in on a demand tariff
  - `spikeStatus` 'none' | 'potential' | 'spike', required — Indicates whether this interval will potentially spike, or is currently in a spike state
  - `descriptor` 'negative' | 'extremelyLow' | 'veryLow' | 'low' | 'neutral' | 'high' | 'spike', required — 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
  - `channelIdentifier` string, required — Meter channel identifier
  - `kwh` number, 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.
  - `cost` number, required — The total cost of your consumption or generation for this period - includes GST

## Other responses

- `400` — Bad request
- `401` — API key is missing or invalid
- `404` — Site not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/amberelectric/apis/amber-electric-public-api.md) · [All operations](https://skmtc.net/amberelectric/apis/amber-electric-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/amberelectric/amber-electric-public-api/versions/1f80cddf9ed6/schema)