Metered in, Balanced out

This guide walks you through the step-by-step process for creating a balanced project using a smart meter, establishing the necessary relationships and retrieving balanced outputs. Before proceeding ensure the following prerequisites are met:

Prerequisites

An API Token has been generated and authentication is successfully set up.

Scenario Overview

The following customer details are provided post-onboarding and must be configured in Solarize via the API. These represent the minimum required information set.

Site

Name: Businesspark
Type: balanced_accurate (iMSys TAF-7)
Balance Resolution: PT15M (15min.)
Address: 10115 Berlin, Germany
Timezone: Europe/Berlin

Meter

Serial: 1ISK0001
Type: iMSys TAF-7

1. Create the Site

The site entity can be created using the /v1/sites endpoint and the values provided by the site.

curl -X POST 'https://api.solarize.energy/v1/sites' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Businesspark",
    "type": "balanced_accurate",
    "balanceResolution": "PT15M",
    "address": {
      "locality": "Berlin",
      "postCode": "10115",
      "country": "DE"
    },
    "timezone": "Europe/Berlin"
}'

2. Create the Meter

Meters are always assigned to a site. Ensure the site.id is available to associate it with the meter. Use the /v1/meters endpoint. Key attributes to note:

mpo: The Metering Point Operator (MPO). Refer to the API Reference for available MPOs. For custom MPOs, contact your Customer Success Manager.
direction: For standard onboarding scenarios, set to consumer. Adjust for other use cases.
identifier: The unique identifier for the meter, typically matching the serial number. Ensure mapping on the implementation side if they differ.
measuring: For TAF-7 meters, set this value to readings_accurate. Refer to the Submit Measurements section for details on other meter types.

curl -X POST 'https://api.solarize.energy/v1/meters' \
-H 'Content-Type: application/json' \
-d '{
    "siteId": "<SITE_ID>",
    "mpo": "<MPO_ID>",
    "direction": "consumer",
    "identifier": "1ISK0001",
    "serial": "1ISK0001",
    "startDate": "2024-12-31T23:00:00.000Z",
    "measuring": "readings_accurate"
}'

3. Configure the Meter Balancing Settings

Ensure the meter is configured as balanced starting from the contract start date by creating a balancing setting. Key attributes to note:

priority: Set to null to distribute energy equally between all consumers. Adjust as needed for specific requirements.

curl -X POST 'https://api.solarize.energy/v1/meter-balancing-settings' \
-H 'Content-Type: application/json' \
-d '{
    "siteId": "<SITE_ID>",
    "meterId": "<METER_ID>",
    "balancing": "participant",
    "startDate": "2025-01-01",
    "priority": 1
}'

After measurements are ingested into the platform, they are queued for the balancing process.

4. Retrieve Balancing Results

The balancing result can be fetched using the /v1/aggregated-balances endpoint. The result includes the balanced values along with the creditor and debtor meters. The example request below shows how to fetch balancing results for the created meter as debitor with a 15-minute interval resolution.

curl -X GET 'https://api.solarize.energy/v1/aggregated-balances?debitorMeterId=<METER_ID>&startDateTime=2024-12-31T23:00:00Z&endDateTime=2025-01-31T23:00:00Z&interval=PT15M' \
-H "Content-Type: application/json"

Customer Onboarding Submit Measurements