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.
+ +