University of Sheffield

University of Sheffield Pvforecast API

PV_Forecast API endpoints.

GitHub OpenAPI

Operations 6

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 #

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-pvforecast-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-pvforecast-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-pvforecast-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sheffield Solar Pvforecast API
  version: 0.1.0
  description: PV_Forecast API endpoints.
tags:
- name: pvforecast
  description: PV_Forecast API endpoints.
paths:
  /pvforecast/api/v4/hicast:
    get:
      tags:
      - pvforecast
      summary: Hicast
      description: Return hicast (historical forecast) data for GSP 0 (national aggregate).
      operationId: hicast_pvforecast_api_v4_hicast_get
      parameters:
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      - name: extra_field
        in: query
        required: false
        schema:
          type: array
          items:
            enum:
            - capacity_mwp
            - installedcapacity_mwp
            type: string
          description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
          default: []
          title: Extra Field
        description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
      - name: extra_fields
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Extra Fields
          description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
          deprecated: true
        description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
        deprecated: true
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: forecast_base_gmt
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Forecast Base Gmt
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvforecast/api/v4/gsp/{gsp_id}:
    get:
      tags:
      - pvforecast
      summary: PV_Forecast GSP data
      description: Get PV_Forecast data for a specific GSP.
      operationId: pvforecast_gsp_pvforecast_api_v4_gsp__gsp_id__get
      parameters:
      - name: gsp_id
        in: path
        required: true
        schema:
          type: integer
          title: Gsp Id
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      - name: extra_field
        in: query
        required: false
        schema:
          type: array
          items:
            enum:
            - capacity_mwp
            - installedcapacity_mwp
            type: string
          description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
          default: []
          title: Extra Field
        description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
      - name: extra_fields
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Extra Fields
          description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
          deprecated: true
        description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
        deprecated: true
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: forecast_base_gmt
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Forecast Base Gmt
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvforecast/api/v4/pes/0:
    get:
      tags:
      - pvforecast
      summary: Pvforecast Pes0
      description: PES forecast data.
      operationId: pvforecast_pes0_pvforecast_api_v4_pes_0_get
      parameters:
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      - name: extra_field
        in: query
        required: false
        schema:
          type: array
          items:
            enum:
            - capacity_mwp
            - installedcapacity_mwp
            type: string
          description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
          default: []
          title: Extra Field
        description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
      - name: extra_fields
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Extra Fields
          description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
          deprecated: true
        description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
        deprecated: true
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: forecast_base_gmt
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Forecast Base Gmt
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvforecast/api/v4/pes/{pes_id}:
    get:
      tags:
      - pvforecast
      summary: PV_Forecast PES data
      description: Get PV_Forecast data for a specific PES region.
      operationId: pvforecast_pes_pvforecast_api_v4_pes__pes_id__get
      parameters:
      - name: pes_id
        in: path
        required: true
        schema:
          type: integer
          maximum: 23
          minimum: 10
          title: Pes Id
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      - name: extra_field
        in: query
        required: false
        schema:
          type: array
          items:
            enum:
            - capacity_mwp
            - installedcapacity_mwp
            type: string
          description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
          default: []
          title: Extra Field
        description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
      - name: extra_fields
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Extra Fields
          description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
          deprecated: true
        description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
        deprecated: true
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: forecast_base_gmt
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Forecast Base Gmt
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvforecast/api/v4/forecast_bases_list:
    get:
      tags:
      - pvforecast
      summary: Forecast Bases List0
      description: Return a list of distinct forecast base datetimes for the given GSP.
      operationId: forecast_bases_list0_pvforecast_api_v4_forecast_bases_list_get
      parameters:
      - name: gsp_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          default: 0
          title: Gsp Id
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: start
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start
      - name: end
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvforecast/api/v4/forecast_bases_list/{gsp_id}:
    get:
      tags:
      - pvforecast
      summary: Forecast Bases List
      description: Return a list of distinct forecast base datetimes for the given GSP.
      operationId: forecast_bases_list_pvforecast_api_v4_forecast_bases_list__gsp_id__get
      parameters:
      - name: gsp_id
        in: path
        required: true
        schema:
          type: integer
          title: Gsp Id
      - name: gsp_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          default: 0
          title: Gsp Id
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: start
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start
      - name: end
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/jwt/login
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: ssapi_session
    HTTPBasic:
      type: http
      scheme: basic