⚡ Live Power

Real-time consumption from Home Mini.

See exactly what you're using right now. Updates every 10-30 seconds. Calculate cost per hour at current rates.

🔌 Smart Charging

Intelligent Octopus dispatch slots.

Know when your EV is charging. See upcoming charge windows. Never miss off-peak rates again.

🎁 Saving Sessions

Free electricity events.

Get notified about upcoming free power events. Track rewards in Octopoints. Never miss free energy.

🔥 Dual Fuel

Electricity + gas support.

Track both meters. Get consumption history. See tariff details for gas and electric.

🤖 AI Agent

Ask questions in plain English.

"What's my current rate?" "How much did I use yesterday?" Powered by Claude.

🖥️ Menu Bar

macOS status bar app.

Live power, current rate, charging status, and balance. Always visible. One click away.

⚡ Basic Usage

import asyncio
from open_octopus import OctopusClient

async def main():
    async with OctopusClient(
        api_key="sk_live_xxx",
        account="A-XXXXXXXX"
    ) as client:
        # Account balance
        account = await client.get_account()
        print(f"Balance: £{account.balance:.2f}")

        # Current rate
        tariff = await client.get_tariff()
        rate = client.get_current_rate(tariff)
        print(f"Rate: {rate.rate}p/kWh")

        # Live power (Home Mini)
        power = await client.get_live_power()
        if power:
            print(f"Power: {power.demand_kw:.2f} kW")

asyncio.run(main())

🔥 With Gas

async with OctopusClient(
    api_key="sk_live_xxx",
    account="A-XXXXXXXX",
    gas_mprn="1234567890",
    gas_meter_serial="G4A12345"
) as client:
    # Gas consumption
    gas = await client.get_daily_gas_usage(days=7)
    for date, kwh in gas.items():
        print(f"{date}: {kwh:.1f} kWh")

    # Gas tariff
    tariff = await client.get_gas_tariff()
    print(f"Rate: {tariff.unit_rate}p/kWh")

Account & Billing

get_account()           # Balance, status, address
get_tariff()            # Electricity tariff
get_gas_tariff()        # Gas tariff
get_current_rate()      # Current rate + off-peak

Consumption

get_consumption()       # Half-hourly readings
get_daily_usage()       # Daily totals
get_gas_consumption()   # Gas readings
get_daily_gas_usage()   # Daily gas totals

Smart Features

get_live_power()        # Real-time watts
get_dispatches()        # Charge windows
get_dispatch_status()   # Currently charging?
get_saving_sessions()   # Free power events

Models

Account                 # Balance, name, status
Tariff / GasTariff      # Rates, standing charge
Rate                    # Current rate, period
Dispatch                # Charge window
LivePower               # Real-time demand
SavingSession           # Free power event