sapnmeterdata 0.2.2

Retrieve interval meter data from SA Power Networks

sapnmeterdata

sapnmeterdata is an unofficial Python client for downloading NEM12 interval meter data from SA Power Networks' Your Meter Data customer portal.

It signs in with an existing SAPN portal account, discovers the NMIs assigned to that account, requests a detailed NEM12 report, and returns the readings as a Pandas DataFrame.

This project is not affiliated with or supported by SA Power Networks. It relies on the portal's web interface and may require updates when that interface changes.

Installation

python -m pip install sapnmeterdata

Version 0.2.2 requires the Pandas-based nemreader 0.9 API. The dependency is therefore constrained to nemreader>=0.9,<1.

SAPN account

Register for the free Your Meter Data service before using this package:

https://www.sapowernetworks.com.au/your-power/manage-your-power-use/your-meter-data/

Only access NMIs for which you are the customer or an authorised representative. Do not commit SAPN credentials to source control.

Example

import os
from datetime import datetime, timedelta

from sapnmeterdata import login


sapn = login(
    os.environ["SAPN_EMAIL"],
    os.environ["SAPN_PASSWORD"],
)

print(sapn.getNMIs())

end = datetime.now()
start = end - timedelta(days=14)
data = sapn.getAllData(start, end)

print(data)

Retrieve one NMI:

from sapnmeterdata import meter


single_meter = meter("YOUR_NMI", sapn)
data = single_meter.getdata(start, end)

Retrieve selected NMIs:

from sapnmeterdata import getall


data = getall(
    ["FIRST_NMI", "SECOND_NMI"],
    start,
    end,
    sapn,
)

If one NMI has no downloadable data for the requested period, getall() emits a MeterDataWarning, skips only that NMI, and continues retrieving the others. The returned DataFrame records those NMIs in data.attrs["skipped_nmis"]. Calling meter.getdata() directly for the same NMI raises NoDataError.

Returned data

Meter readings are returned as a Pandas DataFrame:

• the index contains the interval start timestamp;
• columns use a two-level meter / channel MultiIndex;
• multiple NMIs are outer-joined by timestamp.

Common NEM12 channels include E1 for general consumption, E2 for controlled load, and B1 for solar export. The exact channels depend on the meter configuration.

SAPN data is historical interval data, not a real-time power feed.

Errors

The public exception types are:

• LoginError — the login form changed, credentials were rejected, or SAPN requested another authentication step;
• AuthError — the authenticated session expired or Salesforce remoting metadata could not be found;
• NoDataError — SAPN returned no downloadable NEM12 payload for a particular NMI and date range;
• FetchError — another portal request, RPC response, or NEM12 parse failed.

MeterDataWarning is emitted when getall() catches NoDataError for one NMI and continues with the rest.

Development

Run the unit tests:

python -m unittest discover -s tests -v

Build the source distribution and wheel:

python -m build

See RELEASING.md for the GitHub Actions and PyPI Trusted Publishing setup.