solcast-pv 1.0.0

Asynchronous Python client for Solcast.

About

Solcast provides solar radiation and solar power forecasts, estimated and historical data. This package allows you to get the data from the API and use it in your own application.

Rooftop forecasts are supported for Solcast hobbyist accounts.

Installation

pip install solcast-pv

Datasets

• List of all your created rooftop sites linked to your account.
• Get rate limits for your account.
• Fetch rooftop forecasts, including central, lower and upper power estimates.

Example

import asyncio

from solcast_pv import Solcast, RooftopSite


async def main() -> None:
    """Show example on using this package."""
    async with Solcast(token="API_KEY") as client:
        rooftops: list[RooftopSite] = await client.get_rooftop_sites()
        print(rooftops)


if __name__ == "__main__":
    asyncio.run(main())

Rooftop forecast

async with Solcast(token="API_KEY", timezone="Europe/Amsterdam") as client:
    forecast = await client.get_rooftop_forecast("ROOFTOP_RESOURCE_ID", hours=48)
    print(forecast.total_energy_forecast_today)  # kWh, local calendar day
    print(forecast.power_forecast_now)  # W
    print(forecast.energy_forecast_current_hour)  # kWh, next elapsed hour

Forecast dictionaries contain average power in kW, keyed by interval end in UTC. Energy calculations use each interval's duration and include partial intervals. Calendar-day calculations use the selected timezone, including 23- and 25-hour days. Peak-time methods return the end of the peak interval in that timezone and raise RuntimeError when no interval is available.

Each forecast call makes one API request. The client does not poll or retry requests automatically. Hobbyist accounts currently allow up to 10 requests per UTC day; schedule and cache requests in your application, accounting for all rooftop sites. HTTP 429 raises SolcastRateLimitError (a subclass of SolcastConnectionError). Malformed forecast data raises SolcastResultsError. See the official hobbyist API documentation.

Site listing and usage-allowance methods remain available for compatible accounts; their availability can differ from the documented forecast endpoint.

More examples can be found in the examples folder.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.

This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

• Python 3.12+
• Poetry

Installation

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages.

Prek

This repository uses the prek framework, all changes are linted and tested with each commit. To setup the prek check, run:

poetry run prek install

And to run all checks and tests manually, use the following command:

poetry run prek run --all-files

Testing

It uses pytest as the test framework. To run the tests:

poetry run pytest

To update the syrupy snapshot tests:

poetry run pytest --snapshot-update

License

MIT License

Copyright (c) 2024-2026 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.