Readings

List the energy readings for all projects

get

List the energy readings for a specified date range and aggregate for all projects

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

startstring · date-timeRequired

The inclusive start date

endstring · date-timeRequired

The exclusive end date

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/energy/readings

HTTPcURLJavaScriptPython

GET /energy/readings?start=2025-12-16T02%3A23%3A03.114Z&end=2025-12-16T02%3A23%3A03.114Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projects": {
    "ANY_ADDITIONAL_PROPERTY": {
      "generation": 1,
      "consumption": 1,
      "export": 1,
      "storage": 1,
      "irradianceHours": 1,
      "avoidedEmissions": 1,
      "emissions": 1,
      "sources": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": {
            "reading": 1,
            "start": 1,
            "end": 1
          }
        }
      },
      "sites": {
        "ANY_ADDITIONAL_PROPERTY": {
          "generation": 1,
          "consumption": 1,
          "export": 1,
          "storage": 1,
          "irradianceHours": 1,
          "avoidedEmissions": 1,
          "emissions": 1,
          "sources": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": {
                "reading": 1,
                "start": 1,
                "end": 1
              }
            }
          },
          "systems": {
            "ANY_ADDITIONAL_PROPERTY": {
              "generation": 1,
              "consumption": 1,
              "export": 1,
              "storage": 1,
              "irradianceHours": 1,
              "avoidedEmissions": 1,
              "emissions": 1,
              "sources": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "reading": 1,
                    "start": 1,
                    "end": 1
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "range": {
    "localStartDate": "2025-12-16T02:23:03.114Z",
    "localEndDate": "2025-12-16T02:23:03.114Z"
  },
  "generation": 1,
  "consumption": 1,
  "storage": 1,
  "export": 1,
  "avoidedEmissions": 1,
  "emissions": 1
}