API Capabilities

Pylontech OpenAPI is organized around sites and their devices. The API exposes read operations for resource discovery and operational data, and write operations for device configuration and control.

This page describes the purpose of each API group. Request parameters, response schemas, and field units are documented in the API Reference.

Sites and Devices

A site is the authorization boundary and the parent of one or more devices. Site APIs identify which resources the current client can access. Device APIs return the equipment and capability information needed by subsequent data and control operations.

Site Management

• Get site list
• Get site details

Device Management

• Get all devices
• Get device details

Uplink Data

Uplink APIs read operational data reported by a device to Pylontech Cloud.

Telemetry

Telemetry contains the latest or historical operating values available for a device, including meter, inverter, battery, and PV data where supported by the device type.

• Get latest device telemetry
• Batch get latest device telemetry
• Get historical device telemetry

The batch operation accepts up to 50 device IDs. Historical telemetry is queried by UTC time range and currently supports a maximum range of 30 days per request.

Energy Statistics

Energy statistics aggregate device energy data by day, month, or year.

• Get device energy statistics

The response can include battery charge and discharge energy, PV generation, inverter generation and consumption, and grid import and export energy.

Faults, Alarms, and Notices

Device events are classified as fault, alarm, or notice and can be active or resolved.

• Get device alarms

Downlink Control

Downlink APIs change device behavior. They are divided into three control models:

• Configuration defines persistent settings.
• Schedule defines recurring charge and discharge periods.
• Command applies temporary control values within a specified time window.

See Device Control Models before selecting a write operation.

Device Configuration

• Get device configuration
• Set device configuration
• Batch set device configuration

Configuration includes operating mode, charge and discharge cutoff SOC, site import and export limits, and telemetry sampling rate.

Device Schedule

• Get device schedule
• Set device schedule
• Batch set device schedule

A schedule contains recurring charge or discharge periods expressed in the device's local time.

Device Command

• Get command history
• Send a device command
• Get command status
• Cancel a command
• Batch send device commands
• Cancel a batch command

Commands are asynchronous. A successful submission means the platform accepted the request; the command status must be queried to determine its execution state. See Device Commands for the command lifecycle and control semantics.