# Sheffield Solar API **Canonical:** https://apis.io/apis/university-of-sheffield/sheffield-solar-api/ **Provider:** University of Sheffield — https://apis.io/providers/university-of-sheffield/ **Base URL:** https://api.solar.sheffield.ac.uk **Documentation:** https://www.solar.sheffield.ac.uk/api/ Sheffield Solar API is one of 5 APIs that [University of Sheffield](https://apis.io/providers/university-of-sheffield/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Solar Energy, Energy Data, Research Data, Open Data, and Time Series. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a status page, a support channel, a JSON-LD context, and 2 JSON Schemas. The University of Sheffield's own research API, built and run by the Sheffield Solar group in the Department of Physics and Astronomy. It publishes PV_Live — near-real-time and historical estimates of solar photovoltaic generation on the GB transmission network, by Grid Supply Point and Public Electricity Supplier region — plus PV_Live_EU over European NUTS regions and PV_Forecast day-ahead forecasts. PV_Live read endpoints are keyless and answered 200 on probe; PV_Forecast returns 401 without a registered X-User-Id header. The institution publishes its own OpenAPI 3.1 document, a Swagger UI and a Redoc rendering. This is the one contract in this repository that Sheffield actually wrote. ## Operations (51) | Method | Path | Summary | |---|---|---| | GET | `/pvlive/api/v4/gsp/{gsp_id}` | PV_Live GSP data | | GET | `/pvlive/api/v4/pes/0` | Pvlive Pes0 | | GET | `/pvlive/api/v4/pes/{pes_id}` | PV_Live PES data | | GET | `/pvlive/api/v4/gsp_list` | PV_Live GSP List | | GET | `/pvlive/api/v4/pes_list` | PV_Live PES List | | GET | `/pvlive/api/v4/passiv_reading_count/{start_at}` | Passiv Reading Count | | GET | `/pvlive/api/v4/peakgeneration` | Peakgeneration | | GET | `/pvlive_eu/api/v5/nuts_list` | PV_Live_EU NUTS List | | GET | `/pvlive_eu/api/v5/nuts/{nuts_code}` | PV_Live_EU NUTS | | GET | `/pvforecast/api/v4/hicast` | Hicast | | GET | `/pvforecast/api/v4/gsp/{gsp_id}` | PV_Forecast GSP data | | GET | `/pvforecast/api/v4/pes/0` | Pvforecast Pes0 | | GET | `/pvforecast/api/v4/pes/{pes_id}` | PV_Forecast PES data | | GET | `/pvforecast/api/v4/forecast_bases_list` | Forecast Bases List0 | | GET | `/pvforecast/api/v4/forecast_bases_list/{gsp_id}` | Forecast Bases List | | GET | `/health/live` | Liveness Probe | | GET | `/health/ready` | Readiness Probe | | GET | `/admin/admin_page/{sort_col}/{direction}` | Admin Page | | GET | `/admin/admin_page/` | Admin Page | | GET | `/admin/admin_form/{user_id}` | Admin User Form | | POST | `/admin/admin_page/region/{user_id}` | Submit Region | | POST | `/admin/admin_page/token/{user_id}` | Submit Token | | POST | `/admin/admin_page/token_gen/{user_id}` | Submit Token Gen | | POST | `/admin/admin_page/user/{user_id}` | Submit User | | POST | `/auth/forgot-password` | Reset:Forgot Password | | POST | `/auth/reset-password` | Reset:Reset Password | | POST | `/auth/request-verify-token` | Verify:Request-Token | | POST | `/auth/verify` | Verify:Verify | | POST | `/auth/cookie/login` | Auth:Cookie.Login | | POST | `/auth/cookie/logout` | Auth:Cookie.Logout | | POST | `/auth/jwt/login` | Auth:Jwt.Login | | POST | `/auth/jwt/logout` | Auth:Jwt.Logout | | POST | `/auth/jwt/register` | Register:Register | | GET | `/users/me` | Users:Current User | | PATCH | `/users/me` | Users:Patch Current User | | GET | `/users/{id}` | Users:User | | PATCH | `/users/{id}` | Users:Patch User | | DELETE | `/users/{id}` | Users:Delete User | | GET | `/user/login` | Get Login Form | | POST | `/user/login` | Handle Login | | POST | `/user/register` | Handle Registration | | GET | `/user/register` | Get Register Form | | GET | `/user/logout` | Handle Logout | | GET | `/user/user` | Pvforecast User | | GET | `/user/forgot-password` | Forgot Password Page | | POST | `/user/forgot-password` | Handle Forgot Password | | GET | `/user/reset-password` | Reset Password Page | | POST | `/user/reset-password` | Handle Reset Password Submission | | GET | `/user/verify` | Verify Page | | POST | `/user/verify` | Handle Verify | | GET | `/metrics` | Metrics | ## Machine-readable artifacts (24) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/openapi/university-of-sheffield-sheffield-solar-api-openapi.yml - **OpenAPI** — https://api.solar.sheffield.ac.uk/openapi.json - **Documentation** — https://www.solar.sheffield.ac.uk/api/ - **APIReference** — https://api.solar.sheffield.ac.uk/redoc - **InteractiveDocumentation** — https://api.solar.sheffield.ac.uk/docs - **Portal** — https://api.solar.sheffield.ac.uk/pvlive/docs - **TermsOfService** — https://api.solar.sheffield.ac.uk/tandc - **Status** — https://api.solar.sheffield.ac.uk/pvlive/uptime - **Support** — https://api.solar.sheffield.ac.uk/pvlive/contact - **SourceCode** — https://github.com/SheffieldSolar/PV_Live-API - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/json-schema/university-of-sheffield-pvlive-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/json-schema/university-of-sheffield-pvlive-generation-row-schema.json - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/examples/university-of-sheffield-pvlive-gsp-example.json - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/examples/university-of-sheffield-pvlive-peakgeneration-example.json - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/examples/university-of-sheffield-pvlive-pes-list-example.json - **Examples** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/examples/university-of-sheffield-pvforecast-auth-required-example.json - **Rules** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/rules/university-of-sheffield-rules.yml - **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/vocabulary/university-of-sheffield-vocabulary.yml - **JSONLD** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/json-ld/university-of-sheffield-context.jsonld - **Errors** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/errors/university-of-sheffield-errors.yml - **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/lifecycle/university-of-sheffield-lifecycle.yml - **Authentication** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/authentication/university-of-sheffield-authentication.yml - **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/scopes/university-of-sheffield-scopes.yml - **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/apis.yml ## Other University of Sheffield APIs (4) - [University of Sheffield Shibboleth Identity Provider](https://apis.io/apis/university-of-sheffield/shibboleth-idp/) - [ORDA — Online Research Data (figshare tenant)](https://apis.io/apis/university-of-sheffield/orda/) - [White Rose Research Online OAI-PMH](https://apis.io/apis/university-of-sheffield/wrro-oai/) - [White Rose eTheses Online OAI-PMH](https://apis.io/apis/university-of-sheffield/wreo-oai/) ## Tags Solar Energy, Energy Data, Research Data, Open Data, Time Series --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/university-of-sheffield/sheffield-solar-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/university-of-sheffield/.