REST API
Access real-time and historical energy data programmatically through a clean RESTful API.
Build on Your Energy Data
The EpiSensor REST API gives developers and system integrators direct programmatic access to energy data. Built on standard HTTP methods with JSON responses, it works with any programming language, scripting environment, or integration platform. No proprietary SDKs or libraries required.
Whether you are building a custom dashboard, feeding data into an enterprise reporting system, or automating energy procurement workflows, the REST API provides the flexibility to work with EpiSensor data on your own terms.
How It Works with EpiSensor
The ZGW-10 Gateway hosts a local REST API that provides access to all sensor data, device configuration, and network status. The API follows RESTful conventions: resources are accessed via intuitive URL paths, responses are returned in JSON, and standard HTTP status codes indicate success or failure.
For cloud-based access, the Core platform exposes a cloud REST API that aggregates data across your entire fleet of gateways. Authenticate with API keys, query historical data with time-range filters, and retrieve aggregated or raw readings. The cloud API supports pagination, field selection, and rate limiting to handle large-scale data retrieval efficiently.
Key Features
Local and Cloud Access
Query data directly from the gateway on your local network, or use the Core cloud API to access data from any gateway in your fleet remotely.
JSON Responses
All endpoints return structured JSON with consistent schemas. Sensor metadata, timestamps, values, and units are clearly labelled for easy parsing.
Historical Queries
Retrieve historical data with flexible time-range filters. Specify start and end timestamps, resolution, and aggregation method (min, max, mean, sum).
API Key Authentication
Secure access with API keys that can be scoped to specific gateways, sensors, or read/write permissions. Rotate keys without downtime.
Webhooks
Configure webhooks to push data to your endpoints on a schedule or when thresholds are crossed, reducing the need for continuous polling.
Rate Limiting and Pagination
Built-in rate limiting protects the gateway, while cursor-based pagination makes it efficient to retrieve large datasets without timeouts.
Use Cases
Custom Dashboards
Build bespoke energy dashboards in React, Angular, or any framework. Pull live and historical data from the API to create exactly the visualisation your stakeholders need.
Enterprise Integration
Feed energy data into ERP, CMMS, or sustainability reporting platforms. Use the API with integration tools like Zapier, Make, or custom middleware to automate data flows.
Automated Reporting
Generate automated energy reports by querying historical data via the API. Schedule scripts to pull monthly consumption data for billing, benchmarking, or regulatory compliance.
Getting Started
The local REST API is available on every ZGW-10 gateway out of the box. Access it at the gateway's IP address on the configured port. For the cloud API, generate an API key from the Core platform dashboard. The API reference documentation includes endpoint descriptions, request/response examples, and authentication details.
Start with a simple GET request to the sensors endpoint to list all connected devices. From there, query individual sensor readings, retrieve historical data with time filters, or configure webhooks for push-based delivery. Most integrations are up and running within an hour.
Ready to Build with the EpiSensor API?
Talk to our team about API access and integration support.