energy_data_retrieval.sources.aemo.client#

Public AEMO NEMWeb dispatch-unit SCADA, preserving instantaneous MW.

timestamp is the published SETTLEMENTDATE dispatch label converted from fixed AEST (UTC+10) to UTC. SCADAVALUE is a snapshot at the start of that dispatch interval, not a five-minute average or settlement energy.

class energy_data_retrieval.sources.aemo.client.AEMOListing(urls, request)[source]#

Bases: object

A current directory snapshot, sorted by source filename, with provenance.

Parameters:
urls: tuple[str, ...]#
request: RequestRecord#
class energy_data_retrieval.sources.aemo.client.AEMOGeneration(frame, request)[source]#

Bases: object

Normalized observations and the exact downloaded archive’s provenance.

Parameters:
frame: DataFrame#
request: RequestRecord#
energy_data_retrieval.sources.aemo.client.parse_dispatch_scada(content, *, duids=None, maximum_rows=500000, maximum_uncompressed_bytes=134217728, maximum_members=1000)[source]#

Parse MMS CSV, an interval ZIP, or a daily ZIP of interval ZIPs.

Native fields are retained under source: column names. Missing SCADA readings stay missing, and negative readings stay negative. Duplicate (dispatch label, DUID) keys fail instead of silently choosing a revision. The row bound applies before the optional DUID filter. No technology or generator/load classification is inferred from a DUID’s spelling.

Parameters:
  • content (str | bytes)

  • duids (Sequence[str] | None)

  • maximum_rows (int)

  • maximum_uncompressed_bytes (int)

  • maximum_members (int)

Return type:

DataFrame

class energy_data_retrieval.sources.aemo.client.AEMOClient(http, maximum_rows=500000, maximum_uncompressed_bytes=134217728, maximum_members=1000, maximum_files=5000)[source]#

Bases: object

Read public NEMWeb files using the shared bounded HTTP transport.

No API key is required. Directory listings and current files are transient; retain the returned source URL, retrieval date and SHA-256 with your output.

Parameters:
  • http (HTTPClient)

  • maximum_rows (int)

  • maximum_uncompressed_bytes (int)

  • maximum_members (int)

  • maximum_files (int)

http: HTTPClient#
maximum_rows: int#
maximum_uncompressed_bytes: int#
maximum_members: int#
maximum_files: int#
list_files(*, archive=False)[source]#

Discover current interval ZIPs or available daily archive ZIPs.

Only links to matching files in the requested official directory are returned. The provider’s archive retention is finite; older files may require a different historical source.

Parameters:

archive (bool)

Return type:

AEMOListing

fetch_file(url, *, duids=None)[source]#

Download and parse one validated interval or daily archive URL.

Parameters:
  • url (str)

  • duids (Sequence[str] | None)

Return type:

AEMOGeneration

generation_day(day, *, duids=None)[source]#

Read a daily archive (NEM labels 00:05 through the next day’s 00:00).

Missing/expired archives raise an explicit retrieval error. A day is a native NEM market date, not a UTC calendar date. No completeness is implied when individual unit observations are absent.

Parameters:
  • day (date)

  • duids (Sequence[str] | None)

Return type:

AEMOGeneration