Readings

List the energy readings for all projects

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

get

/energy/readings

Authorizations

Query parameters

startstring · date-timerequired

The inclusive start date

endstring · date-timerequired

The exclusive end date

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.ecosuite.io//energy/readings?start=2025-02-23T22%3A40%3A07.041Z&end=2025-02-23T22%3A40%3A07.041Z' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{
  "range": {
    "localStartDate": "2025-02-23T22:40:07.041Z",
    "localEndDate": "2025-02-23T22:40:07.041Z"
  },
  "generation": 1,
  "consumption": 1,
  "storage": 1,
  "export": 1,
  "avoidedEmissions": 1,
  "emissions": 1,
  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

successful operation