Climkit API

Die Developer API von Climkit ermöglicht es registrierten und autorisierten Entwicklern, Zähler- und Energiedaten von autorisierten Climkit-Standorten abzurufen.

Um sich zu registrieren, müssen Entwickler die Zugriffsrechte auf die Daten beim Eigentümer der Installation und bei Climkit SA einholen.

Anfragen für den API-Zugriff sind an service@climkit.io zu richten.

Die Zugangsdaten für die API unterscheiden sich von den Anmeldedaten für das persönliche Konto im Climkit-Portal.

Die Zugangsdaten dürfen nur von dem registrierten Entwickler verwendet werden. Kollegen und Mitarbeiter müssen einen individuellen Antrag stellen, um eigene Zugriffsrechte zu erhalten.

API-Endpoint: https://api.climkit.io/api/v1

1. Authentifizierung

Die Climkit-API verwendet JSON Web Tokens (https://jwt.io/introduction/), um die Übertragung von Informationen zu sichern.

Sobald der Benutzer mit seinen Zugangsdaten (Benutzername und Passwort) angemeldet ist, erhält er ein für 15 Minuten gültiges Token, das ihm den Zugriff auf die autorisierten Ressourcen ermöglicht.

URL : /auth

Method : POST

Auth required : NO

Authentication through username-password to get an access token

Parameters (POST)
----------
username: str
    The API username
password: str
    The API password

Returns
-------
    {
        'access_token': <str: your-access-token>,
        'valid_until': {'$date': <int: epoch-time-in-milliseconds>},
    }

2. Standorte

Alle Standorte

Die Liste aller Standorte.

URL : /all_installations

Method : GET

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
No parameter

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
The list of all the sites, presented as a list of objects.

Informationen zu einem Standort

Die Parameter eines bestimmten Standorts.

URL : /installation_infos/<site_id>

Method : GET

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
site_id: str
    The object ID of the installation site

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
The parameters of the site:

    {
        'site_ref': <str>,
        'name': <str>,
        'address': {
            'street_name': <str>,
            'street_number': <str>,
            'city': <str>,
            'postal_code': <int>
        },
        'creation_date': <datetime isoformat str>,
        'latitude': <float>,
        'longitude': <float>,
        'timezone': <str>,
    }

3. Zähler

Alle Zähler eines Standorts

Die Liste aller Zähler eines Standorts.

URL : /meter_info/<site_id>

Method : GET

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
site_id: str
    The object ID of the site

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
----------
The list of meters presented as a list of objects:

[
    {
        'id': <str representing the meter's id>
        'type': {'electricity', 'heating', 'cold_water', 'hot_water'},
        'name': <str>,
        'mode': {'consumption', 'production', 'introduction', 'battery'},
        'prim_ad': <int>,
        'is_rule_meter': <boolean>
    },
    ...
]

Geprüfte Daten des Standorts für einen Zählertyp

Die geprüften Zeitreihendaten des Standorts für einen bestimmten Zählertyp, zum Beispiel der gesamte Stromverbrauch oder die PV-Produktion des Standorts.

URL : /site_data/<site_id>/<meter_type>

Method : POST

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
site_id: str
    The object ID of the site
meter_type: str
    The type of meter data: 
    'electricity', 'heating', 'cooling', 'cold_water', 'hot_water' or 'charge_point'    

Parameters (POST)
----------
t_s: str, optional
    The isoformatted datetime, representing the start instant of timeseries, tz-naive in UTC
t_e: str, optional
    The isoformatted datetime, representing the stop instant of timeseries, tz-naive in UTC
sampling_frequency: {'15T', 'H', 'D', 'M', 'Y'}, optional
    The sampling frequency of the returned data list

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
The validated time series data from the site for a specific type of metering, presented as a list of objects:

[
    {
        'conso_total': <total site consumption>,
        'prod_total': <total site electricity (PV) production if type is electricity>,
        'from_ext': <total site consumption from the grid if type is electricity>,
        'self': <total site consumption from solar PV if type is electricity>,
        'to_ext': <total site electricity exported to the grid if type is electricity>,
        'timestamp': <timestamp at the end of the measured period if sampling_frequency is 15T, otherwise start of the period>
    },
    ...
]

Geprüfte Daten eines bestimmten Zählers

Die geprüften Zeitreihendaten eines Zählers für den ausgewählten Zeitraum.

URL : /meter_data/<site_id>/<meter_id>

Method : POST

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
site_id: str
    The ID of the site
meter_id: str
    The ID of the meter

Parameters (POST)
----------
t_s: str, optional
    The isoformatted datetime, representing the start instant of timeseries, tz-naive in UTC
t_e: str, optional
    The isoformatted datetime, representing the stop instant of timeseries, tz-naive in UTC
sampling_frequency: {'15T', 'H', 'D', 'M', 'Y'}, optional
    The sampling frequency of the returned data list

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
The validated time series meter data for the selected period, presented as a list of objects:

[
    {
        'total': <total consumption. If type is electricity, total = self + ext>,
        'self': <total consumption from solar PV if type is electricity>,
        'ext': <total consumption from grid if type is electricity>,
        'timestamp': <timestamp at the end of the measured period if sampling_frequency is 15T, otherwise start of the period>
    },
    ...
]

Rohmessdaten eines bestimmten Zählers

Die Rohmessdaten, inkrementell (Zählerstand) oder differentiell (Intervall einer Lastgangkurve), als Zeitreihen eines Zählers für den ausgewählten Zeitraum stammen direkt vom Zähler ohne Prüfung. Diese Daten sind nur für physische Zähler verfügbar, nicht für simulierte Regelzähler.

URL : /meter_data_raw/<site_id>/<meter_id>

Method : POST

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (GET)
----------
site_id: str
    The ID of the site
meter_id: str
    The ID of the meter

Parameters (POST)
----------
t_s: str, optional
    The isoformatted datetime, representing the start instant of timeseries, tz-naive in UTC
t_e: str, optional
    The isoformatted datetime, representing the stop instant of timeseries, tz-naive in UTC

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
The raw time series meter data for the selected period, presented as a list of objects:

[
    {
        'en_im': <electricity imported meter index if type is electricity>,
        'en_ex': <electricity exported meter index if type is electricity>,
        'heat_energy_kwh': <thermal energy index if type is heating or cooling>,
        'vol_m3': <water volume index if type is cold_water or hot_water>,
        'timestamp': <timestamp at the end of the measured period>
    },
    ...
]

4. Sensoren

Alle Sensoren eines Standorts abrufen

URL : /<site_id>/sensors_list

Method : GET

Auth required : YES mit einem gültigen Token

Parameters (URL)
----------
site_id: str
The ID of the installation site

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
array_like

The list of sensors info formatted as follows:

[
    {
        'id': <str representing an ObjectID>
        'name': <str>,
        'type': <str describing the type of measured quantity>,
        'unit': <str describing the unit of the measured quantity>,
        'model': <str describing the model of the sensor>
    },
    ...
]

Zeitreihendaten für einen bestimmten Sensor abrufen

Die Zeitreihendaten eines Sensors für den ausgewählten Zeitraum. Wenn kein Zeitraum angegeben wird, werden die neuesten Daten zurückgegeben. Der Parameter t_s ist je nach Benutzer/Standort begrenzt.

URL : /<site_id>/sensor_data/<sensor_id>

Method : GET

Auth required : YES mit einem gültigen Token

Requests limit : 1/second

Parameters (URL)
----------
site_id: str
    The ID of the installation site
sensor_id: str
    The ID of the sensor object

Parameters (GET)
----------
t_s: str, optional
    The isoformatted datetime, representing the start instant of the requested timeseries, tz-naive in UTC
t_e: str, optional
    The isoformatted datetime, representing the end instant of the requested timeseries, tz-naive in UTC

Headers
----------
Content-Type: 'application/json'
Authorization: 'Bearer {your-access-token}'

Returns
-------
array_like

The timeseries sensor data of the selected period as a list of objects:

[
    {
        'timestamp': <int timestamp>,
        'value': <float, int>
    },
    ...
]