Reporting location energy usage

Important

Reporting location energy usage is still in beta. If you think you should be reporting on locations and not resources, please contact someone in Spark for more information. If you want to report energy usage for resources, see here.

After receiving and acting on an event such as PriceCurve and LPC, you must send an energy usage report to the Energy Coordination API. This report is used to calculate the compensation for your end-customers.

Report location usage on an event

Reporting energy usage for locations follows the same principles as for resources, only the report format differs slightly.

Report energy usage How to report energy usage.

Report Format

The energy usage payload corresponds to a specific location that has reacted to the event. You can send multiple payloads in the same report if you have locations that have reacted to the same event.

The LocationEnergyUsage-report has the following properties:

• locationId: The id of the location that the energy consumption occurred at.
• meterPointId: The meterPointId of the smart meter the location drew energy from. Used to calculate compensation. Can be omitted if specified on location itself.
• points: An array of energy usage datapoints.
  • kiloWattHours: The energy usage in kWh. This is the total amount of energy that the resource has consumed during the hour.
  • timestamp: The timestamp of the energy usage datapoint. The timestamp must be in UTC, and correspond to the start of the hour. The timestamp must be in the format yyyy-MM-ddTHH:mm:ss.fffZ.
• resolution: The resolution of the energy usage data. Currently only 01:00:00 is supported. The resolution must always match the resolution of the LPC event.
• payloadType: The type of the payload. You must set this to LocationEnergyUsage in order to report the locations energy usage.

Important!

The points array contains the energy usage data for the location. It is very important that these have the same timestamps as the original event, and that the timestamps are in UTC. At the moment each point is 1 hour long, and the timestamp should be the start of the hour.

Ensure correct meterPointId

It is your responsibility as a partner to ensure that the meterPointId you report energy usage for is correct and owned by you or your user. In other words, reported energy usage must show up in the AMS data reading for the provided meterPointId.

Example report

location-energy-usage-example.json

{
  "eventId": "ed7a8a7a-010f-4fad-a2e0-33dab82dccf2",
  "payloads": [
    {
      "locationId": "7751a1c1-e318-4f71-b4f4-5b6e93efb149",
      "meterPointId": "7070575000XXXXXXXX",
      "points": [
        {
          "kiloWattHours": 72,
          "timestamp": "2024-09-12T11:00:00+00:00"
        },
        {
          "kiloWattHours": 79,
          "timestamp": "2024-09-12T12:00:00+00:00"
        }
      ],
      "resolution": "01:00:00",
      "payloadType": "LocationEnergyUsage"
    }
  ]
}