API Reference
API Introduction
The Cleori API provides comprehensive access to the energy trading platform, enabling seamless integration of your energy assets with European electricity markets. Built on REST principles, our API enables real-time telemetry submission, activation processing, and automated market participation.
Base URLs
Production
Text
Use for live market participation
Test Environment
Text
Use for development and testing
API Overview
Version
Current API version: v1
All endpoints are prefixed with /v1/
Architecture
The Cleori API follows REST principles:
- Resource-based URLs with clear, predictable structure
- Standard HTTP methods (GET, POST, PATCH, DELETE)
- JSON format for all requests and responses
- HTTP status codes for clear response handling
Request & Response Format
Request Headers
HTTP
Response Format
All responses follow a consistent JSON structure.
Data Conventions
Timestamps
All timestamps use ISO 8601 format in UTC:
Text
Power Units
- Power: Kilowatts (kW)
- Energy: Kilowatt-hours (kWh)
- Example:
50= 50 kW
Currency
Financial values in EUR with 2 decimal places:
JSON
HTTP Status Codes
| Status Code | Meaning |
|---|---|
| 200 OK | Successful request |
| 201 Created | Resource created successfully |
| 204 No Content | Successful request with no content |
| 400 Bad Request | Invalid request format |
| 401 Unauthorized | Missing or invalid authentication |
| 403 Forbidden | Insufficient permissions |
| 404 Not Found | Resource not found |
| 422 Unprocessable Entity | Validation error |
| 429 Too Many Requests | Rate limit exceeded |
| 500 Internal Server Error | Server error |
| 503 Service Unavailable | Service temporarily unavailable |
Pagination
List endpoints support pagination:
Query Parameters
limit: Items per page (default: 20, max: 100)offset: Number of items to skip
Response Example
JSON
Get Help
- Email: [email protected]