Kehittäjäportaali

← Portaali

Aurinko API

Säteilymäärät ja tuottoarviot Suomen kaupungeille. Tuote: Aurinkodata · tila: suunnitteilla

OpenAPI 3.0

openapi: 3.0.3
info:
  title: Tietolahde Aurinko API
  version: 0.1.0
  description: FMI-pohjaiset aurinkosäteily- ja tuottoarviot
servers:
  - url: https://api.tietolahde.fi/v1
paths:
  /aurinko/yield:
    get:
      summary: Hae tuottoarvio kaupungille
      operationId: getAurinkoYield
      parameters:
        - name: city
          in: query
          required: true
          schema:
            type: string
            enum: [helsinki, tampere, oulu, turku, vantaa]
          description: Kaupungin slug
        - name: kwp
          in: query
          schema:
            type: number
            default: 5
          description: Asennettu teho kilowatteina (kWp)
      responses:
        '200':
          description: Onnistunut vastaus
          content:
            application/json:
              schema:
                type: object
                properties:
                  city:
                    type: string
                  kwp:
                    type: number
                  annual_kwh:
                    type: number
                  ghi_kwh_m2:
                    type: number
        '501':
          description: Tuote ei vielä käytössä tuotannossa

Esimerkkipyyntö

GET https://api.tietolahde.fi/v1/aurinko/yield?city=helsinki&kwp=5
Accept: application/json

Esimerkkivastaus

{
  "city": "helsinki",
  "kwp": 5,
  "annual_kwh": 4200,
  "ghi_kwh_m2": 950
}

Huomiot