Project Overview

Contribute to the OpenElectricity project

Overview

OpenElectricity Documentation

Introduction

Understanding Australian electricity networks and regional structures

Networks

Networks and Regions

Power

Power in Electricity Networks

Energy

Energy in Electricity Networks

Understanding electricity market pricing and trading data

Price

Price and Market Data

Emissions

Documentation of fuel technologies and their groupings in the OpenNEM system

Fueltechs

Fueltechs and Fueltech Groups

Understanding electricity generation facilities and their data structures

Facilities and Generation

Batteries

Batteries in the Australian Electricity Network

Weather station data and environmental metrics

Weather

Weather and Environmental Data

Interconnectors

Introduction to the OpenElectricity Platform

Documentation for the OpenElectricity REST API - Australian Electricity Market Data

Configuration

Get time series data for a network.

This endpoint returns time series data for a network, with optional grouping
by region and other dimensions. The data can be aggregated by different time
intervals.

Args:
    network_code: The network to get data for
    metrics: List of metrics to query (e.g. energy, power, price)
    interval: The time interval to aggregate by
    date_start: Start time for the query
    date_end: End time for the query
    primary_grouping: Primary grouping to apply
    secondary_grouping: Optional secondary grouping to apply
    client: ClickHouse client dependency

Returns:
    APIV4ResponseSchema: Time series data response containing a list of TimeSeries objects,
    one per requested metric

Get Network Data

Get time series data for a specific facility.

This endpoint returns time series data for a facility, with data grouped by unit.
The data can be aggregated by different time intervals.

Args:
    network_code: The network the facility belongs to
    facility_code: The facility code to get data for
    metrics: List of metrics to query (e.g. energy, power, emissions)
    interval: The time interval to aggregate by
    date_start: Start time for the query
    date_end: End time for the query
    client: ClickHouse client dependency

Returns:
    APIV4ResponseSchema: Time series data response containing a list of TimeSeries objects,
    one per requested metric, with data for each unit

Get Facility Data

Get market data for a network.

This endpoint returns market data like price and demand, with optional grouping
by region. The data can be aggregated by different time intervals.

Args:
    network_code: The network to get data for
    metrics: List of metrics to query (e.g. price, demand)
    interval: The time interval to aggregate by
    date_start: Start time for the query
    date_end: End time for the query
    primary_grouping: Primary grouping to apply
    client: ClickHouse client dependency

Returns:
    APIV4ResponseSchema: Time series data response containing a list of TimeSeries objects,
    one per requested metric

Contribute

​Project Overview

Project Overview