API Documentation
  • API Documentation
  • Ecosuite Project Data API
    • Authentication
    • OpenAPI reference
      • Events
        • Resolve
      • Feedback
      • Profile
      • Portfolios
      • Projects
        • Contacts
        • Pro forma
          • Versions
        • I2x
        • Records
        • Sites
          • Records
          • Systems
            • Records
        • Record documents
      • Record documents
      • Records
        • Record documents
      • Service requests
        • Generate
        • Resolve
      • Tariff
      • User groups
      • Users
        • Alerts
        • Groups
          • Reset
        • Mfa
        • Notifications
        • Resend
      • User types
      • Audit
        • Assets
        • Projects
        • Users
      • Coda
        • Milestones
        • Import
      • Connectivity
        • Data
        • Devices
      • Dashboard
        • Status
      • Energy
        • Datums
          • Most recent
          • Projects
          • Consumption
            • Cost
              • Projects
            • Predicted
              • Projects
            • Projects
          • Cumulative
            • Projects
          • Generation
            • Expected
            • Predicted
              • Projects
          • Nodes
            • Projects
        • Export
        • Instantaneous
        • Readings
        • Status
      • Finance
        • Cashflow totals
        • Report
        • Transactions
        • Sources uses
          • Sources uses
        • Export
          • Report
        • Projects
          • Billing
          • CashFlowTimeSeriesArrears
          • Categories
          • Irr categories
          • Report
          • Settings
          • Sources uses
          • Import
          • Cash flows
            • Payment logs
          • Pro forma
            • Irr
        • Record
          • Payments
        • Softledger
          • Locations
      • Media
        • Files
        • Tags
          • Storage
            • Code
            • Labels
          • Default
        • Storage
          • File
          • Code
      • Public
        • Projects
        • Energy
          • Datums
            • Projects
          • Readings
            • Projects
      • Schemas
        • Rfi
        • RfiReply
        • Dr event
        • Dr notification
        • Event
        • Participant
        • Finance
        • Notification
        • Portfolio
        • Pro forma
        • Profile
        • Project
        • Record
        • Service request
        • Site
        • System
        • User
        • User type
        • User groups
        • New tariff
        • Tariff
      • Rfi
        • Thread
          • Code
          • Resolve
          • Version
          • Replies
        • Reply
          • Version
      • Search
        • Refinements
      • Solarnetwork
        • Devices
        • Instruction
        • Nodes
        • Ssh
        • Credentials
          • Solarflux
          • Solarnode
          • Ssh
        • Metadata
          • Projects
        • Settings
          • Node ids
        • Solarnode
          • Login url
      • Tools
        • Address business details
      • Dr
        • Participants
        • Dr events
        • Dr notifications
      • Report
        • Operating
          • Project
      • Weather
        • Datums
          • Projects
        • Daylight
          • Projects
            • Sites
        • Projects
          • Sites
    • OpenAPI Specification
  • Ecosuite Time Series Data API
Powered by GitBook
On this page
  1. Ecosuite Project Data API
  2. OpenAPI reference
  3. Energy

Readings

PreviousInstantaneousNextStatus

List the energy readings for all projects

get

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

Authorizations
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
GET //energy/readings 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-06-16T12:36:14.296Z",
    "localEndDate": "2025-06-16T12:36:14.296Z"
  },
  "generation": 1,
  "consumption": 1,
  "storage": 1,
  "export": 1,
  "avoidedEmissions": 1,
  "emissions": 1
}