pybluecurrent

Python client for BlueCurrent charge points.

pybluecurrent is an unofficial, third-party async client — it is not affiliated with BlueCurrent.

Compared to BlueCurrent's official bluecurrent-api:

• Per-call async/await — each method awaits its own response, rather than a single callback receiver that routes every server message.
• Typed responses — getters return TypedDict-annotated dictionaries; the official client hands back untyped dicts.
• Instance-scoped state — no process-global mutable state.
• Username/password or API token — the official client is API-token only.

Installation

Requires Python 3.10 or newer. Install with pip:

pip install pybluecurrent

or with uv:

uv add pybluecurrent

This also installs the pybluecurrent command — no extra needed.

Usage

Using the client is as simple as:

from pybluecurrent import BlueCurrentClient

client = BlueCurrentClient("your_username", "your_secret_password")

async with client:
    charge_points = await client.get_charge_points()
    transactions = await client.get_transactions(charge_points[0]["evse_id"])

Connection

The client can only be used while its websocket is connected. For example:

client = BlueCurrentClient("your_username", "your_secret_password")
async with client:
    result = await client.get_account()

Entering the async context automatically logs in.

Instead of a username and password, you can authenticate with an API token:

client = BlueCurrentClient(api_token="your_api_token")

Retrieve or rotate the token with get_api_token and generate_api_token, or from the BlueCurrent website.

Command line

Installing the package also installs a pybluecurrent command, which exports your transactions:

export BLUECURRENT_USERNAME="your_username"
export BLUECURRENT_PASSWORD="your_secret_password"

pybluecurrent transactions --format csv -o transactions.csv
pybluecurrent transactions --format json --days 30
pybluecurrent transactions --format jsonl --evse-id BCU123456

Credentials come from BLUECURRENT_USERNAME / BLUECURRENT_PASSWORD (or BLUECURRENT_API_TOKEN), or from the matching --username / --password / --api-token options.

Options

• --format: csv (default), json (one array) or jsonl (one object per line).
• --evse-id: Charge point to export, repeatable. Defaults to all of your charge points.
• --days: Only export the last N days. Defaults to your whole history.
• -o, --output: Write to a file instead of stdout.
• --newest-first / --oldest-first: Output order, newest first by default.

Methods

Every method is a coroutine on BlueCurrentClient; call them inside the async context (see Connection). Charge points are addressed by their evse_id.

• Account & authentication — get_account, get_api_token, generate_api_token, get_contracts
• Charge points & cards — get_charge_points, get_charge_point_settings, get_charge_point_status, get_charge_point_statuses, get_charge_cards
• Grid & sustainability — get_grid_status, get_grids, get_sustainability_status
• Settings & control — set_plug_and_charge_charge_card, set_status, set_capacity_tariff, unlock_connector, soft_reset, reboot
• Smart charging — set_delayed_charging, set_delayed_charging_schedule, set_price_based_charging, set_price_based_charging_settings, boost
• Transactions — get_transactions, iterate_transactions

Response models

The getters return plain dictionaries annotated with TypedDicts from pybluecurrent.models. Access is unchanged — response["key"], .get(), **response and json.dumps all keep working — and an unexpected field the backend adds simply rides along; the types just add autocomplete and static checking:

from pybluecurrent.models import ChargePoint, Transaction

The model definitions are the field-level reference — each field, its type, and any parsing notes live there. The response types are Account, ChargeCard, ChargePoint, ChargePointSettings, ChargePointStatus, GridStatus, Grid, SustainabilityStatus, Contract, TransactionsPage and Transaction, built from the nested shapes Tariff, Location, Address, DelayedCharging, PriceBasedCharging, CapacityTariff, CardRef, BoolSetting and IntSetting. Dates and times are parsed for you: date/datetime fields are Python objects, and schedule times (start_time, end_time, expected_departure_time) are datetime.time.

Account & authentication

get_account

async def get_account(self) -> Account

Returns your account information as an Account.

get_api_token

async def get_api_token(self) -> str

Returns the API token (home automation key) for your account. It can be used to authenticate instead of a username and password, by constructing the client with BlueCurrentClient(api_token=...).

generate_api_token

async def generate_api_token(self) -> str

Generates a new API token and returns it. Warning: this rotates the token — any previously issued token is invalidated, which will break anything still using the old one.

get_contracts

async def get_contracts(self) -> list[Contract]

Returns your contracts, each a Contract.

Charge points & cards

get_charge_points

async def get_charge_points(self) -> list[ChargePoint]

Returns your charge points, each a ChargePoint. A disabled smart-charging profile is still present as its {value, permission} wrapper; its schedule/settings fields appear only while the profile is enabled.

get_charge_point_settings

async def get_charge_point_settings(self, evse_id: str) -> ChargePointSettings

Returns the settings of a charge point as a ChargePointSettings. All of this is already included in the response of get_charge_points.

Arguments

• evse_id: The ID of the charge point.

get_charge_point_status

async def get_charge_point_status(self, evse_id: str, socket_id: int | None = None) -> ChargePointStatus

Returns the live status of a single socket as a ChargePointStatus. Most charge points have a single socket, and omitting socket_id returns it whatever its number. Dual-socket models (such as the NanoXL) have a socket per side, and there is no sensible default between them: name the socket_id you want, or use get_charge_point_statuses to fetch them all. Raises ValueError if the charge point has no socket with the given socket_id, or if socket_id is omitted for a multi-socket charge point.

Arguments

• evse_id: The ID of the charge point.
• socket_id: The socket to fetch. May be omitted for a single-socket charge point.

get_charge_point_statuses

async def get_charge_point_statuses(self, evse_id: str) -> list[ChargePointStatus]

Returns the live status of every socket of a charge point, each a ChargePointStatus. Single-socket charge points return a one-element list; dual-socket models return one entry per socket, each tagged with its socket_id.

Arguments

• evse_id: The ID of the charge point.

get_charge_cards

async def get_charge_cards(self) -> list[ChargeCard]

Returns your charge cards, each a ChargeCard.

Grid & sustainability

get_grid_status

async def get_grid_status(self, evse_id: str) -> GridStatus

Returns the grid status associated with a charge point (currents in amps) as a GridStatus.

Arguments

• evse_id: The ID of the charge point.

get_grids

async def get_grids(self) -> list[Grid]

Returns your grid connections, each a Grid.

get_sustainability_status

async def get_sustainability_status(self) -> SustainabilityStatus

Returns sustainability statistics for all your charge points as a SustainabilityStatus — {"trees": ..., "co2": ...}.

Settings & control

set_plug_and_charge_charge_card

async def set_plug_and_charge_charge_card(self, evse_id: str, uid: str | None = None) -> None

Sets the plug-and-charge card for the charge point. uid must be the uid of one of your charge cards, or None to charge without a card. Raises BlueCurrentException if the command fails.

Arguments

• evse_id: The ID of the charge point.
• uid: A charge card UID, or None (the default) to use no charge card.

set_status

async def set_status(self, evse_id: str, enabled: bool, socket_id: int | None = None) -> None

Enables or disables a socket of a charge point. The call returns once the backend confirms the change, and raises BlueCurrentException if it fails — for example when the charge point does not respond.

Arguments

• evse_id: The ID of the charge point.
• enabled: Boolean that indicates the desired status.
• socket_id: The socket to enable or disable. May be omitted for a single-socket charge point.

unlock_connector

async def unlock_connector(self, evse_id: str, socket_id: int | None = None) -> None

Unlocks the connector of a charge point. Raises BlueCurrentException if the command fails, and NotImplementedError for portable (UMOVE) charge points, which are not supported.

Arguments

• evse_id: The ID of the charge point.
• socket_id: The socket to unlock. May be omitted for a single-socket charge point.

soft_reset

async def soft_reset(self, evse_id: str) -> None

Soft-resets a charge point. Raises BlueCurrentException if the command fails.

Arguments

• evse_id: The ID of the charge point.

reboot

async def reboot(self, evse_id: str) -> None

Reboots a charge point — a full reboot, as opposed to the software reset of soft_reset. Raises BlueCurrentException if the command fails.

Arguments

• evse_id: The ID of the charge point.

set_capacity_tariff

async def set_capacity_tariff(self, evse_id: str, enabled: bool, max_kwh: float | None = None) -> None

Enables, updates or disables the capacity-tariff setting of a charge point: an on/off toggle with a maximum energy value in kWh, applied by the backend. The configured state is read back from the capacity_tariff field of the charge point settings, where the value appears as max_kwh.

Arguments

• evse_id: The ID of the charge point.
• enabled: Whether the capacity tariff should be enabled.
• max_kwh: The maximum energy value in kWh, from 0.01 to 80 inclusive. Required when enabling; must be omitted when disabling.

Smart charging

set_delayed_charging

async def set_delayed_charging(self, evse_id: str, enabled: bool) -> None

Enables or disables delayed charging. While enabled, the charge point only charges within the window configured with set_delayed_charging_schedule, and delays charging outside of it. A charge point has at most one smart-charging profile active, so enabling this disables any other profile.

Arguments

• evse_id: The ID of the charge point.
• enabled: Whether delayed charging should be enabled.

set_delayed_charging_schedule

async def set_delayed_charging_schedule(
    self,
    evse_id: str,
    start_time: time | str,
    end_time: time | str,
    days: Iterable[Weekday | int | str],
) -> None

Sets the window in which the charge point may charge on the selected days. The window may span midnight. It is applied only while delayed charging is enabled with set_delayed_charging.

from datetime import time
from pybluecurrent import Weekday

await client.set_delayed_charging_schedule(
    "BCU123456", start_time=time(23, 0), end_time=time(7, 0), days=[Weekday.MONDAY, "tu", 3]
)

Arguments

• evse_id: The ID of the charge point.
• start_time: The time at which charging may start, as a time or a "HH:MM" string.
• end_time: The time at which charging must stop, as a time or a "HH:MM" string.
• days: The days on which the schedule applies. Each day may be a pybluecurrent.Weekday, an isoweekday number (1 for Monday through 7 for Sunday), or a name such as "monday" or "mo".

The schedule is read back from the delayed_charging key of get_charge_point_settings.

set_price_based_charging

async def set_price_based_charging(self, evse_id: str, enabled: bool) -> None

Enables or disables price-based charging. While enabled, the charge point charges during the cheapest hours before the expected departure time, as configured with set_price_based_charging_settings. A charge point has at most one smart-charging profile active, so enabling this disables any other profile.

Arguments

• evse_id: The ID of the charge point.
• enabled: Whether price-based charging should be enabled.

set_price_based_charging_settings

async def set_price_based_charging_settings(
    self,
    evse_id: str,
    expected_departure_time: time | str,
    expected_kwh: float,
    minimum_kwh: float,
) -> None

Configures how much energy to charge before departure. Applied only while price-based charging is enabled with set_price_based_charging.

Arguments

• evse_id: The ID of the charge point.
• expected_departure_time: The time the vehicle is expected to leave, as a time or a "HH:MM" string.
• expected_kwh: The amount of energy, in kWh, expected to be charged before departure.
• minimum_kwh: The amount of energy, in kWh, to charge immediately regardless of price.

The settings are read back from the price_based_charging key of get_charge_point_settings.

boost

async def boost(self, evse_id: str) -> None

Starts charging immediately, overriding whichever smart-charging profile is currently delaying charging — delayed charging or price-based charging — for the ongoing session. The override cannot be undone. While it is active, get_charge_point_status reports "boosting": True. Raises ValueError if no smart-charging profile is active.

Arguments

• evse_id: The ID of the charge point.

Transactions

get_transactions

async def get_transactions(
    self,
    evse_id: str,
    newest_first: bool = True,
    page: int = 1,
    start_date: date | None = None,
    end_date: date | None = None,
) -> TransactionsPage

Returns a single page of transactions as a TransactionsPage; its transactions key holds a list of Transaction.

Arguments

• evse_id: The ID of the charge point.
• newest_first: If True, start with the most recent transaction. Defaults to True.
• page: Page number to get. Defaults to 1.
• start_date: Only return transactions from this date onwards. Omitted by default.
• end_date: Only return transactions up to this date. Omitted by default.

iterate_transactions

async def iterate_transactions(
    self,
    evse_id: str,
    newest_first: bool = True,
    start_date: date | None = None,
    end_date: date | None = None,
) -> AsyncIterable[Transaction]

Iterates over all your transactions, fetching further pages as needed. Yields Transaction dictionaries.

Arguments

• evse_id: The ID of the charge point.
• newest_first: If True, start with the most recent transaction. Defaults to True.
• start_date: Only return transactions from this date onwards. Omitted by default.
• end_date: Only return transactions up to this date. Omitted by default.

Development

• Install (editable, with dev extras): uv sync --extra dev (or pip install -e ".[dev]").
• Pre-commit: the repo ships a .pre-commit-config.yaml, but git installs no hooks on clone, so it is a one-time manual step — run uvx pre-commit install.
• Contributions and feature requests are welcome.

Changelog

See CHANGELOG.md.