FlipFlip Energy API

Introduction

Welcome to Flip's API documentation.

The API is split in two sections:

Mobile App API

It is meant to be used as the backend for the VPP tab of your mobile app, and is only used to provide end-users with information about their participation in VPPs.

Cloud API

It is meant to connect directly to your cloud, which itself connects to devices. It includes endpoints for:

  • monitoring (Telemetry)
  • control (Commands)
  • fetching authentication tokens to use in the mobile app (Site authentication)
  • commissioning devices in our system (Commissioning)
  • receiving machine-to-machine updates (Webhooks)

Base URLs

EnvironmentURL
Productionhttps://api.flip.energy
Sandboxhttps://api-sandbox.flip.energy

Authentication

All requests require a Bearer token in the Authorization header:

Authorization: Bearer <your_token>

See the Authentication page for details on token types.