Skip to main content
The Lumenaza API is a RESTful HTTP API that lets you manage energy consumers, producers, contracts, prices, market data, and more within the Lumenaza platform. All endpoints are served under the /v3/ path prefix and communicate exclusively using JSON — both request bodies and response payloads. Key conventions:
  • All request bodies must be encoded as JSON with Content-Type: application/json.
  • All responses are JSON objects or arrays (except 204 No Content).
  • HTTP verbs follow standard REST semantics: GET (read), POST (create), PUT/PATCH (update), DELETE (remove).

​
Base URLs

All endpoint paths in this reference are relative to the base URL. For example, the full URL for GET /v3/consumers/ in production is:
Use the test environment for integration development and sandbox testing. Data in the test environment is isolated from production.

​
Authentication

Every request must carry a valid Bearer token in the Authorization header:
Tokens are issued by Lumenaza. Requests without a valid token receive a 401 Unauthorized response. Tokens should be treated as secrets — never expose them in client-side code or version control.
If your token has expired or is invalid, the API returns 401 Unauthorized. Contact Lumenaza support to rotate or reissue credentials.

​
Pagination

List endpoints may return paginated results in one of two styles:

​
Envelope-style pagination

Some endpoints return a JSON envelope object with the following fields:

​
Limit/offset pagination

Other endpoints accept limit and offset as query parameters: Combine both to page through large datasets:

​
Date and Time

All date-time values in request bodies and response payloads are expressed in UTC using the ISO 8601 format:
Example: 2024-01-15T00:00:00Z Plain date fields (e.g. sepa_date, order_date) use the YYYY-MM-DD format without a time component.
Submitting date-times in local time or with non-UTC offsets may cause unexpected behaviour or validation errors. Always normalise to UTC before sending.

​
API Version

The current API version is v3. The version is embedded in every endpoint path:

​
Resource Groups

The API is organised into the following resource groups (tags):

​
Rate Limiting

Rate limiting policies are not publicly specified. If your integration requires guaranteed throughput or you are experiencing throttling, contact Lumenaza support to discuss your requirements.

​
Explore the API

Errors & Troubleshooting

HTTP status codes, field-level validation errors, and debugging tips.

List Consumers

Retrieve a list of consumers or look up a single consumer by ID.

Create Consumer

Register a new consumer and contract via a single POST request.

Producers

Manage energy producers connected to the platform.

Prices

Query tariff and pricing data for products.

Master Data

Manage address, bank data, and other customer master data changes.