-
-# Solcast API Python SDK
-
-Python SDK to access the Solcast API
-
-[](https://github.com/Solcast/solcast-api-python-sdk/actions/workflows/docs.yml) [](https://github.com/Solcast/solcast-api-python-sdk/actions/workflows/test.yml) [](https://github.com/Solcast/solcast-api-python-sdk/actions/workflows/publish-to-pypi.yml)
-
----
-
-**Documentation**: https://solcast.github.io/solcast-api-python-sdk/
-
-## Install
-
-```commandline
-pip install solcast
-```
-
-or from source:
-
-```commandline
-git clone https://github.com/Solcast/solcast-api-python-sdk.git
-cd solcast-api-python-sdk
-pip install .
-```
-
-The base solcast sdk install requires only the python standard library.
-Pandas is the only optional dependency that adds functionality to the package.
-
-```commandline
-pip install solcast pandas
-```
-
-The example notebooks use a variety of optional dependencies to showcase different
-ways in which the Solcast API may be used. To install these dependencies run
-
-```commandline
-pip install solcast[all]
-```
-
-
-## Basic Usage
-
-```python
-from solcast import live
-
-res = live.radiation_and_weather(
- latitude=-33.856784,
- longitude=151.215297,
- output_parameters=['air_temp', 'dni', 'ghi']
-)
-res.to_dict()
-res.to_pandas() # requires optional pandas installation
-```
-
-Don't forget to set your [account Api Key](https://toolkit.solcast.com.au/register) with:
-`export SOLCAST_API_KEY={your commercial api_key}`
-
----
-
-## Contributing
-
-Tests are run against the Solcast API, you will need an API key to run them.
-They are executed on `unmetered locations` and as such won't consume your requests.
-
-```commandline
-pytest tests
-```
-
-## Docs
-
-From the directory run
-```bash
-mkdocs build
-mkdocs serve
-```
-In a browser navigate to `localhost:8000` to see the documentation.
-
-### Formatters and Linters
-
-| Language | Formatter/Linter |
-| -------- | ---------------- |
-| `yaml` | `yamlls` |
-| `toml` | `taplo` |
-| `python` | `black` |
-
-### Recommended Python Development Version
-
-Develop on the oldest supported `Python` version.
-
-```bash
-uv python pin 3.8
-```
diff --git a/aggregations/index.html b/aggregations/index.html
new file mode 100644
index 0000000..55b5778
--- /dev/null
+++ b/aggregations/index.html
@@ -0,0 +1,1674 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ More information in the API Docs.
+The module aggregations has 2 available methods:
| Endpoint | +API Docs | +
|---|---|
live |
+details | +
forecast |
+details | +
from solcast import aggregations
+
+res = aggregations.forecast(
+ collection_id="country_total",
+ aggregation_id="it_total",
+ output_parameters=['percentage', 'pv_estimate']
+)
+
+res.to_pandas().head()
+| period_end | +percentage | +pv_estimate | +
|---|---|---|
| 2024-06-13 04:30:00+00:00 | +1 | +333.499 | +
| 2024-06-13 05:00:00+00:00 | +3.6 | +1157.39 | +
| 2024-06-13 05:30:00+00:00 | +7 | +2268.41 | +
| 2024-06-13 06:00:00+00:00 | +10.4 | +3361.17 | +
| 2024-06-13 06:30:00+00:00 | +14.4 | +4630.91 | +
Handles all API get requests for the different endpoints.
+ + + + + + + + + +__init__(base_url, endpoint, response_type)
+
+Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ base_url
+ |
+
+ str
+ |
+
+
+
+ the base URL to Solcast API + |
+ + required + | +
+ endpoint
+ |
+
+ str
+ |
+
+
+
+ one of Solcast API's endpoints + |
+ + required + | +
delete(params)
+
+Wrap _make_request to make a DEL request
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ params
+ |
+
+ dict
+ |
+
+
+
+ a dictionary of parameters that are passed in the DEL request + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Response
+ |
+
+
+
+ a Response object. + |
+
get(params)
+
+Wrap _make_request to make a GET request
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ params
+ |
+
+ dict
+ |
+
+
+
+ a dictionary of parameters that are passed in the GET request + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Response
+ |
+
+
+
+ a Response object. + |
+
make_url()
+
+Compose the full URL.
+ +patch(params)
+
+Wrap _make_request to make a PATCH request
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ params
+ |
+
+ dict
+ |
+
+
+
+ a dictionary of parameters that are passed in the PATCH request + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Response
+ |
+
+
+
+ a Response object. + |
+
post(params)
+
+Wrap _make_request to make a POST request
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ params
+ |
+
+ dict
+ |
+
+
+
+ a dictionary of parameters that are passed in the POST request + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Response
+ |
+
+
+
+ a Response object. + |
+
put(params)
+
+Wrap _make_request to make a PUT request
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ params
+ |
+
+ dict
+ |
+
+
+
+ a dictionary of parameters that are passed in the PUT request + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Response
+ |
+
+
+
+ a Response object. + |
+
+ Bases: Response
Class to handle API response from the Solcast API for timeseries data.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
code |
+
+ int
+ |
+
+
+
+ HTTP status code of the response + |
+
url |
+
+ str
+ |
+
+
+
+ The URL that was requested + |
+
data |
+
+ Optional[bytes]
+ |
+
+
+
+ Raw response data as bytes + |
+
success |
+
+ bool
+ |
+
+
+
+ Whether the request was successful + |
+
method |
+
+ str
+ |
+
+
+
+ HTTP method used (GET, POST, etc.) + |
+
exception |
+
+ Optional[str]
+ |
+
+
+
+ Exception message if request failed + |
+
Examples:
+>>> response = Response(code=200, url="...", data=b"...", success=True, method="GET")
+>>> response.to_pandas()
+to_pandas()
+
+Return the data as a Pandas DataFrame with a DatetimeIndex.
+ +Class to handle any API response from the Solcast API.
+ + +Attributes:
+| Name | +Type | +Description | +
|---|---|---|
code |
+
+ int
+ |
+
+
+
+ HTTP status code of the response + |
+
url |
+
+ str
+ |
+
+
+
+ The URL that was requested + |
+
data |
+
+ Optional[bytes]
+ |
+
+
+
+ Raw response data as bytes + |
+
success |
+
+ bool
+ |
+
+
+
+ Whether the request was successful + |
+
method |
+
+ str
+ |
+
+
+
+ HTTP method used (GET, POST, etc.) + |
+
exception |
+
+ Optional[str]
+ |
+
+
+
+ Exception message if request failed + |
+
Examples:
+>>> response = Response(code=200, url="...", data=b"...", success=True, method="GET")
+>>> response.to_dict()
+to_dict()
+
+Return the data as a dictionary.
+ +