electricityinfo-nz 1.0.0rc2

Python client for the WITS Market Prices API (Electricity Info NZ)

electricityinfo-nz

---

Documentation: https://github.com/dan-s-github/api-electricityinfo-nz/blob/main/docs/index.md

Source Code: https://github.com/dan-s-github/api-electricityinfo-nz

---

Python client for the WITS Market Prices API (/api/market-prices/v1) for New Zealand wholesale electricity prices.

Installation

Install this via pip:

pip install electricityinfo-nz

Requires Python 3.9+.

Quick start

Create credentials in the WITS Developer Portal:

1. Sign up in the portal.
2. Create an application under My Apps.
3. Copy the generated Client ID and Client Secret.
4. Enable the API services your application needs.

Official guide: https://developer.electricityinfo.co.nz/WITS/guides

from electricityinfo_nz import MarketPricesClient

client = MarketPricesClient(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)

result = client.get_schedule_prices(
    schedule="PRSL",
    market_type="E",
    nodes=["OTA2201"],
    forward=48,
)

For a next-24h forecast, use PRSL by default. Use market_type="E" for energy prices and market_type="R" for reserve prices. Prices are expressed in NZD/MWh.

More detailed guides:

• Installation: https://github.com/dan-s-github/api-electricityinfo-nz/blob/main/docs/installation.md
• Usage: https://github.com/dan-s-github/api-electricityinfo-nz/blob/main/docs/usage.md
• OpenAPI spec: https://github.com/dan-s-github/api-electricityinfo-nz/blob/main/docs/market-prices.yaml
• Contributing: https://github.com/dan-s-github/api-electricityinfo-nz/blob/main/CONTRIBUTING.md

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package wraps the Electricity Info NZ / WITS Market Prices API for the New Zealand wholesale electricity market and is guided by the official WITS Developer Portal documentation.