University of Sheffield

University of Sheffield Health API

The health API from University of Sheffield — 2 operation(s) for health.

GitHub OpenAPI

Operations 2

GET /health/live Liveness Probe #
GET /health/ready Readiness Probe #

Documentation

📖
Documentation
https://www.solar.sheffield.ac.uk/api/
📖
APIReference
https://api.solar.sheffield.ac.uk/redoc
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/authentication/university-of-sheffield-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/openapi/university-of-sheffield-health-api-openapi.yml

Schemas & Data

📊
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

Other Resources

🔗
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
🔗
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
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/university-of-sheffield/refs/heads/main/scopes/university-of-sheffield-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/university-of-sheffield-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

university-of-sheffield-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sheffield Solar Health API
  version: 0.1.0
tags:
- name: Health
paths:
  /health/live:
    get:
      tags:
      - Health
      summary: Liveness Probe
      description: 'Liveness check.

        Purely validates that the event loop isn''t blocked.'
      operationId: liveness_probe_health_live_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Liveness Probe Health Live Get
  /health/ready:
    get:
      tags:
      - Health
      summary: Readiness Probe
      description: 'Readiness check.

        Validates downstream dependencies concurrently.'
      operationId: readiness_probe_health_ready_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Readiness Probe Health Ready Get
components:
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/jwt/login
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: ssapi_session
    HTTPBasic:
      type: http
      scheme: basic