Luxor PlatformAPI DocumentationEnergySites
List settlement points
Retrieves a list of all available settlement points.
Authorization
bearer AuthorizationBearer <token>
In: header
Query Parameters
iso?|
Filter by ISO name
page_number?Page Number
Page number for pagination
Range
1 <= valueDefault
1page_size?Page Size
Number of items per page
Range
1 <= value <= 1000Default
100Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/energy/settlement-points"{ "settlement_points": [ { "comments": "Primary settlement point for Houston area", "created_at": "2025-01-10T08:00:00Z", "description": "Houston load zone settlement point", "display_name": "Houston Load Zone", "id": "cd8d366c-1946-4c89-8110-4b9cd4403a11", "iso_name": "ERCOT", "name": "LZ_HOUSTON", "updated_at": "2025-01-10T08:00:00Z" } ], "pagination": { "page_number": 0, "page_size": 0, "item_count": 0, "previous_page_url": "string", "next_page_url": "string" }}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}Get energy reports
Returns time-ordered telemetry for the last 60 minutes for a site. To retrieve the latest values use page_size = 1 & page_number = 1.
Report energy data
Report energy for an existing site in batches. Reference the getting started documentation here for more information on how you should report load.