Skip to main content

aiosolaredge-one

Async Python client for the SolarEdge ONE (Monitoring API v2) platform. It powers the SolarEdge ONE Home Assistant integration, which lives in its own repo and depends on this package.

Base URL: https://monitoringapi.solaredge.com/v2 · Auth: either an X-API-Key header (plus optional X-Account-Key for Fleet accounts) or an OAuth 2.0 Site Access bearer token (token_provider=).

Status: alpha. Endpoint coverage and models are derived from Phase 0 live captures. Some query-param names and the storage/battery/environmental paths are still unconfirmed pending docs.

Install (dev)

python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

Usage

import aiohttp
from aiosolaredge_one import SolarEdgeOneClient

async with aiohttp.ClientSession() as session:
    client = SolarEdgeOneClient(session, api_key="...")
    sites = await client.get_sites()
    overview = await client.get_site_overview(sites[0].site_id)
    print(overview.production.total, overview.production.unit)
    power = await client.get_power(sites[0].site_id)
    print("current power:", power.latest_value, power.unit)

OAuth 2.0 Site Access

The client does not run the OAuth flow or refresh tokens. Pass an async callable that returns a currently valid access token; it is awaited before every request and sent as Authorization: Bearer …:

async def get_token() -> str:
    ...  # refresh if needed, then return the access token

client = SolarEdgeOneClient(session, token_provider=get_token)
site = await client.get_site_details(site_id)  # Site Access tokens are per-site

OAUTH2_AUTHORIZE_URL, OAUTH2_TOKEN_URL, the OAUTH2_SCOPE_* constants and OAUTH2_MAX_ACCESS_DURATION are exported for callers that implement the flow. SolarEdge's token endpoint expects a JSON body, not form encoding.

What it covers (Phase 0-confirmed endpoints)

Method Endpoint
get_sites() GET /sites
get_site_overview(id) GET /sites/{id}/overview
get_devices(id) GET /sites/{id}/devices
get_energy(id, ...) GET /sites/{id}/energy
get_power(id, ...) GET /sites/{id}/power
get_alerts(id) GET /sites/{id}/alerts

Rate limiting: the client exposes client.rate_limit (per-minute limit + remaining, parsed from response headers) and an optional CreditLedger for tracking the monthly quota locally (not exposed by the API).

Metadata

Release files for aiosolaredge-one 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiosolaredge-one 0.4.0
File Size Uploaded Provenance Actions
aiosolaredge_one-0.4.0.tar.gz 24.7 kB With provenance Details for aiosolaredge_one-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aiosolaredge-one 0.4.0
File Interpreter ABI Platform Actions
aiosolaredge_one-0.4.0-py3-none-any.whl Python 3 none any Details for aiosolaredge_one-0.4.0-py3-none-any.whl

Total release size: 40.9 kB

Release files / aiosolaredge_one-0.4.0.tar.gz

Download URL aiosolaredge_one-0.4.0.tar.gz
Size 24.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a79ec73c167912de004999630789bd91569c018aee6ed2697b6ff53098cee291
BLAKE2b-256 checksum
How to use checksums
865327a9af7710f1376f2c33ec5f43e7c40577a18dd8f461a1f9953a4cdf3cac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Release files / aiosolaredge_one-0.4.0-py3-none-any.whl

Download URL aiosolaredge_one-0.4.0-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
74853735fdf88481d7955a77bea81cd9c2c1d9cbdc7a5d37a65affa436b09290
BLAKE2b-256 checksum
How to use checksums
17915e8f286cff47b64a4a71e8b0a7f903850048e0b021a389b8d7f67fcf5b6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Security for aiosolaredge-one 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for aiosolaredge_one-0.4.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page