amberelectric

What it is and what it does

Amberelectric is an auto-generated OpenAPI client for the Amber Electric API, a real-time wholesale electricity pricing service in Australia. It wraps the Amber API to let you query current and forecast electricity prices for your site, check renewable energy percentages by state, and retrieve historical usage data. The library is built on pydantic for data validation and uses urllib3 for HTTP requests, making it straightforward to integrate price-aware automation into Python applications—for example, scheduling energy-intensive tasks when prices are low.

The package targets developers building home automation or energy management systems that need to react to wholesale price signals. It requires Python 3.7 or later and depends on four common libraries (aenum, pydantic, python-dateutil, urllib3), all of which have low install friction. The API client is generated from an OpenAPI specification, so the interface is stable and well-documented, but the package itself has been dormant—updates are infrequent, though the repository remains open and recent commits suggest it is not abandoned.

Use it for:

• Automate air-conditioner or heat pump scheduling to run during low-price periods, reducing electricity bills.
• Monitor real-time wholesale prices and trigger alerts when prices spike or drop below a threshold.
• Build a dashboard that displays current and forecast prices alongside historical usage to identify savings opportunities.
• Coordinate pool pump or water heater operation with renewable energy availability and price signals.
• Fetch historical usage data to analyze consumption patterns and validate billing accuracy.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides a Python interface to the Amber Electric API for querying real-time and forecast electricity prices, current renewable energy percentages, and historical usage data for Australian sites.

Yes, if you are an Amber Electric customer in Australia building price-aware automation. The package has low install friction, permissive licensing, no known vulnerabilities, and covers the core use case well. However, be aware that maintenance is dormant—updates are infrequent, so verify that the API endpoints you need are functional in version 2.0.12 before committing to production.

Install

amberelectric on PyPI

pip install amberelectric

uv add amberelectric

poetry add amberelectric

Installing amberelectric

Before you install

Low install friction with four lightweight runtime dependencies. The package is dormant but the repository remains active with a recent commit on 2024-11-19, suggesting maintenance is infrequent rather than abandoned.

License in practice

Licensed under Apache-2.0 (permissive), allowing commercial and private use with minimal restrictions—suitable for most use cases including proprietary applications.

Quickstart

pip install amberelectric

import os
import amberelectric
from amberelectric.rest import ApiException

configuration = amberelectric.Configuration(
    access_token=os.environ["BEARER_TOKEN"]
)

with amberelectric.ApiClient(configuration) as api_client:
    api_instance = amberelectric.AmberApi(api_client)
    prices = api_instance.get_current_prices(site_id='your_site_id')
    print(prices)

Requires a valid Amber Electric API bearer token (set via BEARER_TOKEN environment variable) and a registered site ID.

Verify before relying

• Whether the package is actively maintained or if infrequent updates indicate community-driven maintenance only.
• Real-world reliability and performance under production load for automation use cases.
• Whether all five documented API endpoints are fully functional in version 2.0.12.

Package facts

Evidence: amberelectric-2.0.12-py3-none-any.whl

Keywords: OpenAPI, OpenAPI-Generator, Amber Electric Public API

Tags

More WWW/HTTP packages