Last updated: December 11, 2024
Steadysun
is a leader in weather & power forecasting solutions and this API provides an easy way to
integrate
these data into your system.
Built on REST principles, it is designed to be easy to use and quick to implement.
With our API, you can access custom weather and power forecasts, configure solar and wind systems, and tailor data formats to your needs — all in just two steps: creation and operation.
1. Creation: create and configure your systems
| Module | Description | Link |
|---|---|---|
| Solar Power System | Configure your solar systems | PVsystem |
| Wind Power System | Configure your windfarm | Windfarm |
| Weather System | Configure your met systems | Metsystem |
| Group System | Handle your portfolio with gathering of systems | Group |
2. Operate: Get system forecasts or send measures
Steadysun API requires HTTPS and a token-based authentication. Your token must be placed in the authorization header prefixed by 'Token' like in the following example :
headers = {'Authorization': 'Token
254b.....e098384..........xxx'}
| key | value |
|---|---|
| Authorization | Token ADD_TOKEN_HERE |
All responses are in JSON format. For more details, please refer to each endpoint's description.
You'll find below the meaning of each response status code.
| Result | StatusCode | Meaning |
|---|---|---|
| Success | 200 OK | Successful GET or PATCH request |
| 201 OK | Successful POST request An object was created |
|
| 204 OK | Successful DELETE request An object was deleted |
|
| Error | 400 Bad Request | The format or content of the request might be invalid (Please refer to the response body error message) |
| 401 Unauthorized | The request did not contain a valid Token (Please refer to authentication) |
|
| 403 Forbidden | Token valid, but not with the permission to make this API request | |
| 429 Too many requests | The request exceeds the rate limit of calls allowed for your subscription plan | |
| Failed | 500 Internal Server Error | Something unexpected went wrong during the request (if persisting, please contact us and include any error messages) |
| 502 Bad Gateway Error | Unexpected probably due to a server timeout. Try again after 30
seconds (if persisting, please contact us and include any error messages) |