### GET /sites

Source: https://api.amber.com.au/v1/swagger

Retrieves a list of all sites associated with the API key.

```APIDOC
## GET /sites

### Description
Retrieves a list of all sites associated with the API key.

### Method
GET

### Endpoint
/sites

### Parameters

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **sites** (array) - A list of site objects.

#### Response Example
```json
{
  "sites": [
    {
      "name": "Home",
      "siteId": "01J23BAP2SFA218BMV8A73Y9Z9",
      "regionId": "VIC1",
      "hasNextBillingPeriod": true
    }
  ]
}
```
```

--------------------------------

### GET /sites/{siteId}/prices

Source: https://api.amber.com.au/v1/swagger

Retrieves all prices between the specified start and end dates for a given site.

```APIDOC
## GET /sites/{siteId}/prices

### Description
Returns all the prices between the start and end dates.

### Method
GET

### Endpoint
/sites/{siteId}/prices

### Parameters
#### Path Parameters
- **siteId** (string) - Required - ID of the site you are fetching prices for. Can be found using the `/sites` endpoint.

#### Query Parameters
- **startDate** (string) - Optional - Return all prices for each interval on and after this day. Defaults to today. The difference between `startDate` and `endDate` must not exceed 7 days.
- **endDate** (string) - Optional - Return all prices for each interval on and before this day. Defaults to today. The difference between `startDate` and `endDate` must not exceed 7 days.
- **resolution** (integer) - Optional - Specify the required interval duration resolution. Valid options: 5, 30. Default: Your billing interval length.

### Request Example
```json
{
  "siteId": "01J23BAP2SFA218BMV8A73Y9Z9",
  "startDate": "2021-05-05",
  "endDate": "2021-05-05",
  "resolution": 30
}
```

### Response
#### Success Response (200)
- **intervals** (array) - A list of priced intervals.

#### Response Example
```json
{
  "intervals": [
    {
      "startTime": "2021-05-05T00:00:00Z",
      "endTime": "2021-05-05T00:30:00Z",
      "retailPrice": 0.25,
      "costPrice": 0.15,
      "unitOfMeasure": "AUD/kWh"
    }
  ]
}
```
```

--------------------------------

### Get Current Pricing API

Source: https://api.amber.com.au/v1/swagger

Retrieves the current wholesale electricity price for a specified site.

```APIDOC
## GET /sites/{siteId}/current_price

### Description
Fetches the current real-time wholesale electricity price for a given site. This is useful for making immediate decisions on energy consumption based on live market rates.

### Method
GET

### Endpoint
/sites/{siteId}/current_price

### Parameters
#### Path Parameters
- **siteId** (string) - Required - The unique identifier of the site.

### Request Example
```json
{
  "example": "GET /sites/01F5A5CRKMZ5BCX9P1S4V990AM/current_price"
}
```

### Response
#### Success Response (200)
- **data** (object)
  - **centsPerKwh** (number) - The current wholesale price in cents per kilowatt-hour.
  - **timestamp** (string) - The timestamp when this price was effective (ISO 8601 format).
  - **isPeak** (boolean) - Indicates if the current price is within a peak period.

#### Response Example
```json
{
  "data": {
    "centsPerKwh": 25.5,
    "timestamp": "2023-10-27T10:30:00Z",
    "isPeak": true
  }
}
```
```

--------------------------------

### Get Site Usage

Source: https://api.amber.com.au/v1/swagger

Retrieves all usage data for a specified site between a given start and end date. The API can only return a maximum of 90 days of data, and the difference between start and end dates must not exceed 7 days.

```APIDOC
## GET /sites/{siteId}/usage

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

### Method
GET

### Endpoint
`/sites/{siteId}/usage`

### Parameters
#### Path Parameters
- **siteId** (string) - Required - ID of the site you are fetching usage for. Can be found using the `/sites` enpoint

#### Query Parameters
- **startDate** (string) - Required - Return all usage for each interval on and after this day. The difference between `startDate` and `endDate` must not exceed 7 days.
- **endDate** (string) - Required - Return all usage for each interval on and before this day. The difference between `startDate` and `endDate` must not exceed 7 days.
- **resolution** (integer) - Optional - Deprecated. Usage will always be returned in your billing interval length. If you supply this parameter, it will be ignored.

### Request Example
```json
{
  "example": "/sites/01J23BAP2SFA218BMV8A73Y9Z9/usage?startDate=2021-05-05&endDate=2021-05-05"
}
```

### Response
#### Success Response (200)
- **[Array of Interval objects]** - Usage for the requested period. The array contains objects with details about each usage interval.

#### Response Example
```json
{
  "example": "Usage data would be returned here in an array of Interval objects."
}
```

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

--------------------------------

### GET /sites

Source: https://api.amber.com.au/v1/swagger

Retrieves a list of all sites associated with the authenticated user's account. This endpoint is useful for managing or querying information about the user's connected energy sites.

```APIDOC
## GET /sites

### Description
Returns all sites linked to your account. This is useful for managing or querying your connected energy sites.

### Method
GET

### Endpoint
/sites

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

### Request Example
```json
{
  "example": "(No request body for GET request)"
}
```

### Response
#### Success Response (200)
- **Array of Site objects** (array) - A list of sites linked to the account.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "region": "string",
    "type": "string"
  }
]
```
```

--------------------------------

### GET /sites/{siteId}/prices/current

Source: https://api.amber.com.au/v1/swagger

Retrieves the current electricity price for a given site.

```APIDOC
## GET /sites/{siteId}/prices/current

### Description
Returns the current price.

### Method
GET

### Endpoint
/sites/{siteId}/prices/current

### Parameters
#### Path Parameters
- **siteId** (string) - Required - ID of the site you are fetching prices for. Can be found using the `/sites` endpoint.

#### Query Parameters
- **next** (integer) - Optional - Return the _next_ number of forecast intervals. The total number of intervals requested must not exceed 2048.

### Request Example
```json
{
  "siteId": "01J23BAP2SFA218BMV8A73Y9Z9",
  "next": 48
}
```

### Response
#### Success Response (200)
- **prices** (array) - A list of current and upcoming prices.

#### Response Example
```json
{
  "prices": [
    {
      "startTime": "2023-10-27T09:30:00Z",
      "endTime": "2023-10-27T10:00:00Z",
      "retailPrice": 0.30,
      "costPrice": 0.20,
      "unitOfMeasure": "AUD/kWh"
    }
  ]
}
```
```

--------------------------------

### Get All Sites (OpenAPI)

Source: https://api.amber.com.au/v1/swagger

This OpenAPI snippet defines an endpoint to retrieve a list of all sites associated with the authenticated account. This endpoint requires API key authentication and returns a list of sites. Rate limiting headers are included in the response.

```openapi
{
  "tags": [
    "Amber"
  ],
  "description": "Return all sites linked to your account",
  "operationId": "getSites",
  "security": [
    {
      "apiKey": []
    }
  ],
  "parameters": [],
  "responses": {
    "200": {
      "description": "A list of sites.",
      "headers": {
        "RateLimit-Limit": {
          "$ref": "#/components/headers/RateLimit-Limit"
        },
        "RateLimit-Remaining": {
          "$ref": "#/components/headers/RateLimit-Remaining"
        },
        "RateLimit-Reset": {
          "$ref": "#/components/headers/RateLimit-Reset"
        },
        "RateLimit-Policy": {
          "$ref": "#/components/headers/RateLimit-Policy"
        }
      }
    }
  }
}
```

--------------------------------

### Get Pricing Forecast API

Source: https://api.amber.com.au/v1/swagger

Retrieves the forecast for wholesale electricity prices for a specified site over a future period.

```APIDOC
## GET /sites/{siteId}/price_forecast

### Description
Retrieves a forecast of wholesale electricity prices for a specific site. This endpoint provides anticipated price changes, allowing for proactive energy management and scheduling of high-consumption activities.

### Method
GET

### Endpoint
/sites/{siteId}/price_forecast

### Parameters
#### Path Parameters
- **siteId** (string) - Required - The unique identifier of the site.

#### Query Parameters
- **numberOfDays** (integer) - Optional - The number of future days for which to retrieve the price forecast. Defaults to 2.

### Request Example
```json
{
  "example": "GET /sites/01F5A5CRKMZ5BCX9P1S4V990AM/price_forecast?numberOfDays=3"
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of price forecast objects.
  - **timestamp** (string) - The timestamp for the forecast period (ISO 8601 format).
  - **centsPerKwh** (number) - The forecasted wholesale price in cents per kilowatt-hour.
  - **isPeak** (boolean) - Indicates if the forecasted price is within a peak period.

#### Response Example
```json
{
  "data": [
    {
      "timestamp": "2023-10-27T11:00:00Z",
      "centsPerKwh": 28.0,
      "isPeak": true
    },
    {
      "timestamp": "2023-10-27T11:30:00Z",
      "centsPerKwh": 26.5,
      "isPeak": true
    }
  ]
}
```
```

--------------------------------

### Get Usage Data API

Source: https://api.amber.com.au/v1/swagger

Retrieves historical electricity usage data for a specified channel and time period.

```APIDOC
## GET /sites/{siteId}/channels/{channelId}/usage

### Description
Fetches historical electricity usage data for a specific channel of a given site. This endpoint allows you to retrieve detailed usage patterns over a defined period, useful for analysis and automation.

### Method
GET

### Endpoint
/sites/{siteId}/channels/{channelId}/usage

### Parameters
#### Path Parameters
- **siteId** (string) - Required - The unique identifier of the site.
- **channelId** (string) - Required - The identifier of the channel for which to retrieve usage data.

#### Query Parameters
- **from** (string) - Required - The start of the period for which to retrieve usage data (ISO 8601 format).
- **to** (string) - Required - The end of the period for which to retrieve usage data (ISO 8601 format).

### Request Example
```json
{
  "example": "GET /sites/01F5A5CRKMZ5BCX9P1S4V990AM/channels/E1/usage?from=2023-01-01T00:00:00Z&to=2023-01-02T00:00:00Z"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of usage records.
  - **timestamp** (string) - The timestamp of the usage record (ISO 8601 format).
  - **value** (number) - The electricity usage in kWh for the interval.

#### Response Example
```json
{
  "data": [
    {
      "timestamp": "2023-01-01T00:00:00Z",
      "value": 0.5
    },
    {
      "timestamp": "2023-01-01T00:05:00Z",
      "value": 0.7
    }
  ]
}
```
```

--------------------------------

### GET /websites/api_amber_au_v1/usage

Source: https://api.amber.com.au/v1/swagger

Retrieves usage statistics for a given website within a specified date range. Supports filtering by date.

```APIDOC
## GET /websites/api_amber_au_v1/usage

### Description
Retrieves usage statistics for a given website within a specified date range. Supports filtering by date.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/usage

### Parameters
#### Query Parameters
- **date_from** (string) - Required - The start date for the usage data (YYYY-MM-DD).
- **date_to** (string) - Required - The end date for the usage data (YYYY-MM-DD).

### Request Example
```
GET /websites/api_amber_au_v1/usage?date_from=2023-01-01&date_to=2023-01-07
```

### Response
#### Success Response (200)
- **usage** (array) - An array of Usage objects.

##### Usage Object
- **date** (string) - The date of the usage data.
- **views** (integer) - The number of views on that date.
- **visits** (integer) - The number of visits on that date.
- **unique_visitors** (integer) - The number of unique visitors on that date.

#### Response Example
```json
{
  "usage": [
    {
      "date": "2023-01-01",
      "views": 100,
      "visits": 50,
      "unique_visitors": 40
    },
    {
      "date": "2023-01-02",
      "views": 120,
      "visits": 60,
      "unique_visitors": 55
    }
  ]
}
```

#### Error Responses
- **400** (Bad request) - Invalid request parameters.
- **401** (API key is missing or invalid) - Authentication failed.
- **404** (Site not found) - The specified site does not exist.
- **422** (Requested date range is greater than 7 days) - The date range exceeds the allowed limit.
- **500** (Internal Server Error) - An unexpected error occurred on the server.
```

--------------------------------

### GET /state/{state}/renewables/current

Source: https://api.amber.com.au/v1/swagger

Retrieves the current percentage of renewable energy in the grid for a specified state. It supports querying for future forecast intervals or past actual intervals, and allows specifying the resolution of the data.

```APIDOC
## GET /state/{state}/renewables/current

### Description
Returns the current percentage of renewables in the grid for a specified state. This endpoint can also fetch future forecast intervals or past actual intervals, and allows for resolution specification.

### Method
GET

### Endpoint
/state/{state}/renewables/current

### Parameters
#### Path Parameters
- **state** (string) - Required - State you would like the renewables for. Valid states: nsw, sa, qld, vic

#### Query Parameters
- **next** (integer) - Optional - Return the _next_ number of forecast intervals. Example: 48
- **previous** (integer) - Optional - Return the _previous_ number of actual intervals. Example: 48
- **resolution** (integer) - Optional - Specify the required interval duration resolution. Valid options: 5, 30. Default: 30

### Request Example
```json
{
  "example": "(No request body for GET request)"
}
```

### Response
#### Success Response (200)
- **Array of Renewable objects** (array) - The current percentage of renewables in the grid.

#### Response Example
```json
[
  {
    "id": "2023-10-27T00:00:00Z",
    "state": "vic",
    "type": "RENEWABLE_SOURCE",
    "value": 85.7,
    "measurement": "percentage"
  }
]
```

#### Error Responses
- **400** - Bad request
- **404** - State not found
- **500** - Internal Server Error
```

--------------------------------

### Get Current Renewables by State (OpenAPI)

Source: https://api.amber.com.au/v1/swagger

This OpenAPI snippet defines an endpoint to retrieve the current percentage of renewables in the grid for a specified state. It supports query parameters for fetching forecast or historical data and specifies the resolution of the data intervals. The response includes rate limiting headers.

```openapi
{
  "tags": [
    "Amber"
  ],
  "description": "Returns the current percentage of renewables in the grid",
  "operationId": "getCurrentRenewables",
  "security": [],
  "parameters": [
    {
      "name": "state",
      "description": "State you would like the renewables for. Valid states: nsw, sa, qld, vic",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "example": "vic"
    },
    {
      "name": "next",
      "description": "Return the _next_ number of forecast intervals",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer"
      },
      "example": "48"
    },
    {
      "name": "previous",
      "description": "Return the _previous_ number of actual intervals.",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer"
      },
      "example": "48"
    },
    {
      "name": "resolution",
      "in": "query",
      "description": "Specify the required interval duration resolution. Valid options: 5, 30. Default: 30",
      "required": false,
      "schema": {
        "type": "integer",
        "enum": [
          5,
          30
        ],
        "default": 30
      }
    }
  ],
  "responses": {
    "200": {
      "description": "The current percentage of renewables in the grid.",
      "headers": {
        "RateLimit-Limit": {
          "$ref": "#/components/headers/RateLimit-Limit"
        },
        "RateLimit-Remaining": {
          "$ref": "#/components/headers/RateLimit-Remaining"
        },
        "RateLimit-Reset": {
          "$ref": "#/components/headers/RateLimit-Reset"
        },
        "RateLimit-Policy": {
          "$ref": "#/components/headers/RateLimit-Policy"
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Renewable"
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request"
    },
    "404": {
      "description": "State not found"
    },
    "500": {
      "description": "Internal Server Error"
    }
  }
}
```

--------------------------------

### Site Information API

Source: https://api.amber.com.au/v1/swagger

Retrieves information about the user's electricity sites, including NMI, channels, network, and status.

```APIDOC
## GET /sites

### Description
Retrieves a list of all electricity sites associated with the authenticated user. Each site object contains details such as its unique identifier, National Metering Identifier (NMI), associated channels, network provider, and current status.

### Method
GET

### Endpoint
/sites

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filters sites by their status (e.g., 'pending', 'active', 'closed').

### Request Example
```json
{
  "example": "GET /sites?status=active"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of site objects.
  - **id** (string) - Unique Site Identifier.
  - **nmi** (string) - National Metering Identifier (NMI) for the site.
  - **channels** (array) - List of channel objects associated with the site.
    - **identifier** (string) - Identifier of the channel.
    - **type** (string) - Type of the channel (e.g., 'general', 'controlled_load', 'feed_in').
    - **tariff** (string) - The tariff code of the channel.
  - **network** (string) - The name of the site's network.
  - **status** (string) - The current status of the site ('pending', 'active', 'closed').
  - **activeFrom** (string) - Date the site became active (ISO 8601 format).
  - **closedOn** (string) - Date the site closed (ISO 8601 format).
  - **intervalLength** (number) - Length of interval in minutes (5 or 30).

#### Response Example
```json
{
  "data": [
    {
      "id": "01F5A5CRKMZ5BCX9P1S4V990AM",
      "nmi": "3052282872",
      "channels": [
        {
          "identifier": "E1",
          "type": "general",
          "tariff": "A100"
        }
      ],
      "network": "Jemena",
      "status": "active",
      "activeFrom": "2022-01-01",
      "intervalLength": 30
    }
  ]
}
```
```

--------------------------------

### Usage Data API

Source: https://api.amber.com.au/v1/swagger

Retrieves detailed usage data for a specified channel, including consumption in kWh, quality of data, and cost.

```APIDOC
## GET /websites/api_amber_au_v1/usage

### Description
Retrieves detailed usage data for a specified channel, including consumption in kWh, quality of data, and cost.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/usage

### Parameters
#### Query Parameters
- **startDate** (string) - Required - The start date for the usage data (YYYY-MM-DD).
- **endDate** (string) - Required - The end date for the usage data (YYYY-MM-DD).
- **channelIdentifier** (string) - Required - The identifier for the meter channel.

### Request Example
```json
{
  "startDate": "2023-01-01",
  "endDate": "2023-01-31",
  "channelIdentifier": "E1"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of usage objects.
  - **type** (string) - Type of interval, expected to be 'Usage'.
  - **channelIdentifier** (string) - Meter channel identifier.
  - **kwh** (number) - Number of kWh consumed or generated (negative for generated).
  - **quality** (string) - Quality of the data ('estimated' or 'billable').
  - **cost** (number) - Total cost of consumption or generation (includes GST).
  - **duration** (integer) - Length of the interval in minutes.
  - **date** (string) - Date of the interval (ISO 8601 date).
  - **nemTime** (string) - Interval's NEM time (ISO 8601 time).
  - **startTime** (string) - Start time of the interval (ISO 8601 time).
  - **endTime** (string) - End time of the interval (ISO 8601 time).

#### Response Example
```json
{
  "data": [
    {
      "type": "Usage",
      "channelIdentifier": "E1",
      "kwh": 1.5,
      "quality": "billable",
      "cost": 0.30,
      "duration": 30,
      "date": "2023-01-01",
      "nemTime": "2023-01-01T00:30:00+10:00",
      "startTime": "2023-01-01T00:00:00Z",
      "endTime": "2023-01-01T00:30:00Z"
    }
  ]
}
```
```

--------------------------------

### NEM Spot Price Data

Source: https://api.amber.com.au/v1/swagger

Retrieves interval data for the NEM spot price, including actual and forecasted prices.

```APIDOC
## GET /websites/api_amber_au_v1/prices/current

### Description
Retrieves the current interval's electricity price in the NEM, which is a weighted average of actual and forecasted prices. The price is an estimate until the last 5 minutes of the interval.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/prices/current

### Parameters
#### Query Parameters
- **region** (string) - Required - The region for which to retrieve price data.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **amount** (number) - The amount of the spot price in c/kWh.
- **perKwh** (number) - The amount you will pay per kilowatt-hour in c/kWh (includes GST).
- **date** (string) - The date the interval belongs to (ISO 8601 date format).
- **nemTime** (string) - The interval's NEM time (UTC+10, ISO 8601 time format).
- **startTime** (string) - The start time of the interval in UTC (ISO 8601 time format).
- **endTime** (string) - The end time of the interval in UTC (ISO 8601 time format).
- **renewables** (number) - The percentage of renewables in the grid.
- **channelType** (string) - The type of channel.
- **tariffInformation** (object) - Information about the tariff, can be null.
- **spikeStatus** (string) - The status of a price spike.
- **descriptor** (string) - A descriptor for the price.
- **type** (string) - The type of interval (e.g., "CurrentInterval").
- **estimate** (boolean) - Indicates if the current price is an estimate.

#### Response Example
```json
{
  "amount": 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": "",
  "tariffInformation": null,
  "spikeStatus": "",
  "descriptor": "",
  "type": "CurrentInterval",
  "estimate": true
}
```

## GET /websites/api_amber_au_v1/prices/forecast

### Description
Retrieves forecasted electricity prices for a specified period in the NEM.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/prices/forecast

### Parameters
#### Query Parameters
- **region** (string) - Required - The region for which to retrieve price data.
- **startDate** (string) - Required - The start date for the forecast (ISO 8601 date format).
- **endDate** (string) - Required - The end date for the forecast (ISO 8601 date format).

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **amount** (number) - The amount of the spot price in c/kWh.
- **perKwh** (number) - The amount you will pay per kilowatt-hour in c/kWh (includes GST).
- **date** (string) - The date the interval belongs to (ISO 8601 date format).
- **nemTime** (string) - The interval's NEM time (UTC+10, ISO 8601 time format).
- **startTime** (string) - The start time of the interval in UTC (ISO 8601 time format).
- **endTime** (string) - The end time of the interval in UTC (ISO 8601 time format).
- **renewables** (number) - The percentage of renewables in the grid.
- **channelType** (string) - The type of channel.
- **tariffInformation** (object) - Information about the tariff, can be null.
- **spikeStatus** (string) - The status of a price spike.
- **descriptor** (string) - A descriptor for the price.
- **type** (string) - The type of interval (e.g., "ForecastInterval").
- **range** (object) - The price range for the forecast interval.
- **advancedPrice** (object) - Advanced pricing details for the forecast interval.

#### Response Example
```json
[
  {
    "amount": 5.98,
    "perKwh": 23.50,
    "date": "2021-05-06",
    "nemTime": "2021-05-06T13:00:00+10:00",
    "startTime": "2021-05-05T02:30:01Z",
    "endTime": "2021-05-05T03:00:00Z",
    "renewables": 48,
    "channelType": "",
    "tariffInformation": null,
    "spikeStatus": "",
    "descriptor": "",
    "type": "ForecastInterval",
    "range": {
      "lower": 5.50,
      "upper": 6.50
    },
    "advancedPrice": {
      "amount": 5.98,
      "perKwh": 23.50
    }
  }
]
```

## GET /websites/api_amber_au_v1/prices/actual

### Description
Retrieves actual historical electricity prices for a specified period in the NEM.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/prices/actual

### Parameters
#### Query Parameters
- **region** (string) - Required - The region for which to retrieve price data.
- **startDate** (string) - Required - The start date for the actual data (ISO 8601 date format).
- **endDate** (string) - Required - The end date for the actual data (ISO 8601 date format).

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **amount** (number) - The amount of the spot price in c/kWh.
- **perKwh** (number) - The amount you will pay per kilowatt-hour in c/kWh (includes GST).
- **date** (string) - The date the interval belongs to (ISO 8601 date format).
- **nemTime** (string) - The interval's NEM time (UTC+10, ISO 8601 time format).
- **startTime** (string) - The start time of the interval in UTC (ISO 8601 time format).
- **endTime** (string) - The end time of the interval in UTC (ISO 8601 time format).
- **renewables** (number) - The percentage of renewables in the grid.
- **channelType** (string) - The type of channel.
- **tariffInformation** (object) - Information about the tariff, can be null.
- **spikeStatus** (string) - The status of a price spike.
- **descriptor** (string) - A descriptor for the price.
- **type** (string) - The type of interval (e.g., "ActualInterval").

#### Response Example
```json
[
  {
    "amount": 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": "",
    "tariffInformation": null,
    "spikeStatus": "",
    "descriptor": "",
    "type": "ActualInterval"
  }
]
```
```

--------------------------------

### Energy Price and Forecast Data

Source: https://api.amber.com.au/v1/swagger

Retrieve historical and forecasted energy prices, including spot prices, advanced forecasts, and tariff information.

```APIDOC
## GET /websites/api_amber_au_v1/prices

### Description
Retrieves historical and forecasted energy prices for a specified period and location.

### Method
GET

### Endpoint
`/websites/api_amber_au_v1/prices`

### Parameters
#### Query Parameters
- **jurisdiction** (string) - Required - The energy market jurisdiction (e.g., "VIC", "NSW").
- **startDate** (string) - Required - The start date for the data retrieval (YYYY-MM-DD).
- **endDate** (string) - Optional - The end date for the data retrieval (YYYY-MM-DD). Defaults to the current date if not provided.
- **channelType** (string) - Optional - The type of meter channel to retrieve data for. Possible values: "general", "controlledLoad", "feedIn".

### Request Example
```json
{
  "example": "GET /websites/api_amber_au_v1/prices?jurisdiction=VIC&startDate=2023-10-26&channelType=general"
}
```

### Response
#### Success Response (200)
- **intervals** (array) - An array of BaseInterval objects, each representing a time interval with price and forecast details.

#### Response Example
```json
{
  "example": {
    "intervals": [
      {
        "type": "price",
        "duration": 30,
        "spotPerKwh": 0.15,
        "perKwh": 0.18,
        "date": "2023-10-26T00:00:00+11:00",
        "nemTime": "2023-10-25T13:00:00Z",
        "startTime": "2023-10-26T00:00:00+11:00",
        "endTime": "2023-10-26T00:30:00+11:00",
        "renewables": {
          "interval": "great",
          "percentage": 75
        },
        "channelType": "general",
        "spikeStatus": "none",
        "descriptor": "neutral",
        "priceDescriptor": "neutral",
        "renewableDescriptor": "great",
        "tariffInformation": {
          "period": "shoulder"
        },
        "advancedPrice": {
          "low": 0.10,
          "predicted": 0.15,
          "high": 0.20
        }
      }
    ]
  }
}
```
```

--------------------------------

### Renewable Energy API

Source: https://api.amber.com.au/v1/swagger

Retrieves renewable energy percentage data for a specified period.

```APIDOC
## GET /websites/api_amber_au_v1/renewables

### Description
Retrieves renewable energy percentage data for a specified period, including actual, current, and forecasted values.

### Method
GET

### Endpoint
/websites/api_amber_au_v1/renewables

### Parameters
#### Query Parameters
- **startDate** (string) - Required - The start date for the renewable data (YYYY-MM-DD).
- **endDate** (string) - Required - The end date for the renewable data (YYYY-MM-DD).

### Request Example
```json
{
  "startDate": "2023-01-01",
  "endDate": "2023-01-31"
}
```

### Response
#### Success Response (200)
- **actual** (array) - An array of actual renewable data objects.
  - **type** (string) - Type of interval, expected to be 'ActualRenewable'.
  - **duration** (integer) - Length of the interval in minutes.
  - **date** (string) - Date of the interval (ISO 8601 date).
  - **nemTime** (string) - Interval's NEM time (ISO 8601 time).
  - **startTime** (string) - Start time of the interval (ISO 8601 time).
  - **endTime** (string) - End time of the interval (ISO 8601 time).
  - **renewables** (number) - Percentage of renewables in the grid.
  - **descriptor** (object) - Description of the renewable energy source.
- **current** (array) - An array of current renewable data objects (same schema as 'actual').
- **forecast** (array) - An array of forecast renewable data objects (same schema as 'actual').

#### Response Example
```json
{
  "actual": [
    {
      "type": "ActualRenewable",
      "duration": 5,
      "date": "2023-01-01",
      "nemTime": "2023-01-01T00:05:00+10:00",
      "startTime": "2023-01-01T00:00:00Z",
      "endTime": "2023-01-01T00:05:00Z",
      "renewables": 55.2,
      "descriptor": {}
    }
  ],
  "current": [],
  "forecast": []
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.