How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sheffield Solar API

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.

Sheffield Solar API is one of 5 APIs that University of Sheffield publishes on the 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.

This API exposes 51 operations across 43 paths, organized into 10 resource areas, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.solar.sheffield.ac.uk.

51 operations 43 paths 18 schemas 1 DELETE30 GET2 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.solar.sheffield.ac.uk
Authentication
OAuth 2.0, API Key, HTTP Basic
Terms of Service
Resource Areas
10

Authentication & Security 3

Sheffield Solar API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow. An API key is passed in the cookie as ssapi_session (APIKeyCookie). It accepts HTTP basic authentication (HTTPBasic).

Paths & Operations 51

Across 43 paths, the API surfaces 51 operations — 1 DELETE, 30 GET, 2 PATCH, 18 POST. They span 10 resource areas: pvlive, pvlive_eu, pvforecast, health, admin, auth, api-auth, users, Operations, metrics. Each is listed below with its method, path, parameters, and response codes.

pvlive 7

PVLive API endpoints.

GET
/pvlive/api/v4/gsp/{gsp_id}
PVLive GSP data
pvlive_gsp_pvlive_api_v4_gsp__gsp_id__get 9 params → 200422
GET
/pvlive/api/v4/pes/0
Pvlive Pes0
pvlive_pes0_pvlive_api_v4_pes_0_get 8 params → 200422
GET
/pvlive/api/v4/pes/{pes_id}
PVLive PES data
pvlive_pes_pvlive_api_v4_pes__pes_id__get 9 params → 200422
GET
/pvlive/api/v4/gsp_list
PVLive GSP List
pvlive_gsp_list_pvlive_api_v4_gsp_list_get 1 param → 200422
GET
/pvlive/api/v4/pes_list
PVLive PES List
pvlive_pes_list_pvlive_api_v4_pes_list_get 1 param → 200422
GET
/pvlive/api/v4/passiv_reading_count/{start_at}
Passiv Reading Count
passiv_reading_count_pvlive_api_v4_passiv_reading_count__start_at__get 1 param → 200422
GET
/pvlive/api/v4/peakgeneration
Peakgeneration
peakgeneration_pvlive_api_v4_peakgeneration_get → 200
pvlive_eu 2

PVLive EU API endpoints.

GET
/pvlive_eu/api/v5/nuts_list
PVLiveEU NUTS List
pvlive_eu_nuts_list_pvlive_eu_api_v5_nuts_list_get 1 param → 200422
GET
/pvlive_eu/api/v5/nuts/{nuts_code}
PVLiveEU NUTS
pvlive_eu_nuts_pvlive_eu_api_v5_nuts__nuts_code__get 9 params → 200422
pvforecast 6

PVForecast API endpoints.

GET
/pvforecast/api/v4/hicast
Hicast
hicast_pvforecast_api_v4_hicast_get 6 params → 200422
GET
/pvforecast/api/v4/gsp/{gsp_id}
PVForecast GSP data
pvforecast_gsp_pvforecast_api_v4_gsp__gsp_id__get 7 params → 200422
GET
/pvforecast/api/v4/pes/0
Pvforecast Pes0
pvforecast_pes0_pvforecast_api_v4_pes_0_get 6 params → 200422
GET
/pvforecast/api/v4/pes/{pes_id}
PVForecast PES data
pvforecast_pes_pvforecast_api_v4_pes__pes_id__get 7 params → 200422
GET
/pvforecast/api/v4/forecast_bases_list
Forecast Bases List0
forecast_bases_list0_pvforecast_api_v4_forecast_bases_list_get 6 params → 200422
GET
/pvforecast/api/v4/forecast_bases_list/{gsp_id}
Forecast Bases List
forecast_bases_list_pvforecast_api_v4_forecast_bases_list__gsp_id__get 7 params → 200422
health 2
GET
/health/live
Liveness Probe
liveness_probe_health_live_get → 200
GET
/health/ready
Readiness Probe
readiness_probe_health_ready_get → 200
admin 7
GET
/admin/admin_page/{sort_col}/{direction}
Admin Page
admin_page_admin_admin_page__sort_col___direction__get 2 params → 200422
GET
/admin/admin_page/
Admin Page
admin_page_admin_admin_page__get 2 params → 200422
GET
/admin/admin_form/{user_id}
Admin User Form
admin_user_form_admin_admin_form__user_id__get 1 param → 200422
POST
/admin/admin_page/region/{user_id}
Submit Region
submit_region_admin_admin_page_region__user_id__post 1 param → 200422
POST
/admin/admin_page/token/{user_id}
Submit Token
submit_token_admin_admin_page_token__user_id__post 1 param → 200422
POST
/admin/admin_page/token_gen/{user_id}
Submit Token Gen
submit_token_gen_admin_admin_page_token_gen__user_id__post 1 param → 200422
POST
/admin/admin_page/user/{user_id}
Submit User
submit_user_admin_admin_page_user__user_id__post 1 param → 200422
auth 6
POST
/auth/forgot-password
Reset:Forgot Password
reset_forgot_password_auth_forgot_password_post body → 202422
POST
/auth/reset-password
Reset:Reset Password
reset_reset_password_auth_reset_password_post body → 200400422
POST
/auth/request-verify-token
Verify:Request-Token
verify_request_token_auth_request_verify_token_post body → 202422
POST
/auth/verify
Verify:Verify
verify_verify_auth_verify_post body → 200400422
POST
/auth/cookie/login
Auth:Cookie.Login
auth_cookie_login_auth_cookie_login_post body → 200400204422
POST
/auth/cookie/logout
Auth:Cookie.Logout
auth_cookie_logout_auth_cookie_logout_post → 200401204
api-auth 3
POST
/auth/jwt/login
Auth:Jwt.Login
auth_jwt_login_auth_jwt_login_post body → 200400422
POST
/auth/jwt/logout
Auth:Jwt.Logout
auth_jwt_logout_auth_jwt_logout_post → 200401
POST
/auth/jwt/register
Register:Register
register_register_auth_jwt_register_post body → 201400422
users 5
GET
/users/me
Users:Current User
users_current_user_users_me_get → 200401
PATCH
/users/me
Users:Patch Current User
users_patch_current_user_users_me_patch body → 200401400422
GET
/users/{id}
Users:User
users_user_users__id__get 1 param → 200401403404422
PATCH
/users/{id}
Users:Patch User
users_patch_user_users__id__patch 1 param body → 200401403404400422
DELETE
/users/{id}
Users:Delete User
users_delete_user_users__id__delete 1 param → 204401403404422
Operations 12
GET
/user/login
Get Login Form
get_login_form_user_login_get 1 param → 200422
POST
/user/login
Handle Login
handle_login_user_login_post body → 200422
POST
/user/register
Handle Registration
handle_registration_user_register_post body → 200422
GET
/user/register
Get Register Form
get_register_form_user_register_get 1 param → 200422
GET
/user/logout
Handle Logout
handle_logout_user_logout_get → 200
GET
/user/user
Pvforecast User
pvforecast_user_user_user_get → 200
GET
/user/forgot-password
Forgot Password Page
forgot_password_page_user_forgot_password_get 1 param → 200422
POST
/user/forgot-password
Handle Forgot Password
handle_forgot_password_user_forgot_password_post body → 200422
GET
/user/reset-password
Reset Password Page
reset_password_page_user_reset_password_get 1 param → 200422
POST
/user/reset-password
Handle Reset Password Submission
handle_reset_password_submission_user_reset_password_post body → 200422
GET
/user/verify
Verify Page
verify_page_user_verify_get 2 params → 200422
POST
/user/verify
Handle Verify
handle_verify_user_verify_post body → 200422
metrics 1
GET
/metrics
Metrics
metrics_metrics_get → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are UserCreate (10 properties), UserUpdate (10 properties), UserRead (10 properties), Body_handle_registration_user_register_post (9 properties). Each schema is shown below with its type and property counts.

BearerResponse
object
2 properties 2 required
Body_auth_cookie_login_auth_cookie_login_post
object
6 properties 2 required
Body_auth_jwt_login_auth_jwt_login_post
object
6 properties 2 required
Body_handle_forgot_password_user_forgot_password_post
object
1 property 1 required
Body_handle_login_user_login_post
object
8 properties 2 required
Body_handle_registration_user_register_post
object
9 properties 2 required
Body_handle_reset_password_submission_user_reset_password_post
object
2 properties 2 required
Body_handle_verify_user_verify_post
object
1 property 1 required
Body_reset_forgot_password_auth_forgot_password_post
object
1 property 1 required
Body_reset_reset_password_auth_reset_password_post
object
2 properties 2 required
Body_verify_request_token_auth_request_verify_token_post
object
1 property 1 required
Body_verify_verify_auth_verify_post
object
1 property 1 required
ErrorModel
object
1 property 1 required
HTTPValidationError
object
1 property
UserCreate
object
Schema for new user registration.
10 properties 4 required
UserRead
object
Schema returned for user reads. Extends the base with SSF extras.
10 properties 2 required
UserUpdate
object
Schema for user self-updates (PATCH /users/me).
10 properties
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-sheffield-sheffield-solar-api-openapi.yml Raw ↑

Other APIs University of Sheffield publishes across the network.

University of Sheffield Shibboleth Identity Provider
ORDA — Online Research Data (figshare tenant)
White Rose Research Online OAI-PMH
White Rose eTheses Online OAI-PMH
Where this information came from

This is an independent, third-party profile of Sheffield Solar API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.