Flip Energy API
    Flip Energy API
    • Overview
    • Important concepts
    • Authentication
    • Enrollment process
    • End-user app design
    • Monitoring / Telemetry
    • Control
    • Change log
    • Mobile App API
      • Devices
        • Create Device
        • Read Devices
        • Read Device
        • Update Device
        • Delete Device
      • Enrollments
        • Create Enrollment
        • Read Enrollments
        • Read Enrollment
        • Delete Enrollment
      • Events
        • Read Events
        • Read Event
        • Update Event Participation
      • Programs
        • Read Programs
        • Read Program
      • Sites
        • Read Site
        • Update Site
    • Cloud API
      • Sites
        • Get Site Token
        • Get Sites
      • Commissioning
        • Commission Site And Devices
      • Sessions
        • Sessions
      • Commands
        • Command Created
        • Update Command Status
      • Programs
        • Read Programs
      • Telemetry
        • Report Battery Telemetry
      • Webhooks
        • Overview
        • List of events
        • Webhook headers
        • Schemas
          • Command
          • Enrollment
          • Event

    Important concepts

    Our data model was built so that one API could fit all types of VPPs.

    Site#

    A site is an end-user's home. It has an address, a utility contract, and one or more devices.

    Device#

    A device is a single entity that can be controlled independently to provide services to the grid. For instance, a single battery controlled through an inverter count as one device. Similarly, two stacked batteries that cannot be controlled independently count as one device. On the other hand, two batteries which can receive separate inputs count as two devices.

    Commissioning#

    Commissioning is the process of creating the site and devices on Flip's servers.

    Program#

    A program is the construct that utilities created, in other words the VPP, which end-users can participate in to earn money. There are multiple programs across the US, tied with specific utilities or electricity markets, each with their own rules and requirements.

    Enrollment#

    Enrolling is the act of signing up to participate in a VPP program. An enrollment is therefore the relation between a set of devices plus their site, and a program.

    Event#

    When a utility needs power to be provided to the grid, they call an event. It contains a specific set of instructions (a schedule) as well as start and end times.

    Telemetry#

    Telemetry is the monitoring data that is produced by the device.

    Command#

    A command is the final set of instructions that the device should use to operate for a specific event.

    Webhook#

    A webhook is a machine-to-machine notification that is sent from Flip's servers to yours and can be used to learn about changes to the data.
    Modified at 2024-07-08 20:28:06
    Previous
    Overview
    Next
    Authentication
    Built with