flexmeasures.api

Modules

flexmeasures.api.common

Functionality common to all API versions.

flexmeasures.api.dev

Endpoints under development.

flexmeasures.api.play

Endpoints to support "play" mode, data restoration

flexmeasures.api.sunset

A place to keep all routes to endpoints that previously existed and are now sunset.

flexmeasures.api.v3_0

FlexMeasures API v3

FlexMeasures API routes and implementations.

Functions

flexmeasures.api.get_versions() dict

Public endpoint to list API versions.

flexmeasures.api.register_at(app: Flask)

This can be used to register this blueprint together with other api-related things

flexmeasures.api.request_auth_token()

API endpoint to get a fresh authentication access token. Be aware that this fresh token has a limited lifetime (which depends on the current system setting SECURITY_TOKEN_MAX_AGE).

Pass the email parameter to identify the user. Pass the password parameter to authenticate the user (if not already authenticated in current session)