List cities

Retrieves a paginated list of cities filtered by ISO and settlement point. Cities are physically located within an ISO and a settlement point.

Authorization

AuthorizationRequiredBearer <token>

In: header

Query Parameters

isoIso

Filter by ISO name (e.g., 'ERCOT')

settlement_point_idSettlement Point Id

Filter by settlement point UUID

page_numberPage Number

Page number for pagination

Default: 1Minimum: 1

page_sizePage Size

Number of items per page

Default: 100Minimum: 1Maximum: 1000

curl -X GET "https://app.luxor.tech/api/v1/energy/cities?iso=string&settlement_point_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page_number=1&page_size=100" \
  -H "Authorization: Bearer <token>"

Successful Response

{
  "cities": [
    {
      "created_at": "2025-01-10T08:00:00Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "iso_name": "ERCOT",
      "name": "Houston",
      "settlement_point_id": "cd8d366c-1946-4c89-8110-4b9cd4403a11",
      "settlement_point_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"
  }
}

List cities

Authorization

Query Parameters

Response

TypeScript