Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EcoFlow Quota API

Read device property (quota) values and send device function commands

EcoFlow Quota API is one of 3 APIs that EcoFlow publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Quota. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.ecoflow.com, https://api-e.ecoflow.com.

3 operations 2 paths 6 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ecoflow.com
Authentication
API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

EcoFlow Quota API declares 4 security schemes for authenticating requests. An API key is passed in the header as accessKey (accessKey). An API key is passed in the header as nonce (nonce). An API key is passed in the header as timestamp (timestamp). An API key is passed in the header as sign (sign). By default, every request must be authenticated.

  • accessKey — Access key issued in the EcoFlow developer console.
  • nonce — Random nonce (typically a 6-digit number) regenerated per request.
  • timestamp — Unix timestamp in milliseconds at request time.
  • sign — HMAC-SHA256 signature (hex) over the ASCII-sorted request parameters concatenated with accessKey, nonce and timestamp, keyed by the secretKey.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Quota 3

Read device property (quota) values and send device function commands

GET
/iot-open/sign/device/quota/all
Get all quota for a device
getAllQuota 1 param → 200400401500
POST
/iot-open/sign/device/quota
Get selected quota values
getQuota body → 200400401500
PUT
/iot-open/sign/device/quota
Set a device function (command)
setQuota body → 200400401500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SetQuotaRequest (4 properties), GetQuotaRequest (2 properties), Envelope (2 properties). Each schema is shown below with its type and property counts.

CommandResponse
QuotaResponse
Envelope
object
Standard EcoFlow response envelope.
2 properties 2 required
GetQuotaRequest
object
2 properties 2 required
SetQuotaRequest
object
4 properties 1 required
ErrorResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ecoflow-quota-api-openapi.yml Raw ↑

Other APIs EcoFlow publishes across the network.

EcoFlow Devices API
EcoFlow MQTT API