Site

_idId (string)

Example: 5eb7cf5a86d9755df3a6c593

partner_idPartner Id (string)required

Possible values: Value must match regular expression ^[a-zA-Z0-9_-]{1,64}$

site_idSite Id (string)required

Possible values: Value must match regular expression ^[a-zA-Z0-9_-]{1,64}$

nameName (string)required

location objectrequired

nameName (string)required

coordinatesarrayrequired

Possible values: >= 3, <= 3

countryCountry (string)required

activeActive (boolean)

Default value: false

validation_status object

anyOf

ValidationStatus

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

site_configuration_status object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

configuration_added object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

configuration_complete object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

missing_assetsstring[]

Default value: []

valid_for_optimization object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

validation_errors object

anyOf

string

string

null

null

optimization_configuration_status object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

ingress_status object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

receiving_measurement_data object

statusValidationStatusEnum (string)

Possible values: [ERROR, WARNING, OK, UNKNOWN]

Default value: UNKNOWN

not_receiving_data_fromstring[]

Default value: []

last_validationstring<date-time>

null

null

configurations object

anyOf

ConfigurationBuilder

site_configuration object

anyOf

SiteConfiguration

device_list object[]required

Array [

oneOf

AcChargingPole3Phase

nameName (string)required

The name of the device itself. This value will be used as the asset ID in the rest of the API.

collectorCollector (string)required

The name of the collector to which this device is connected.

typeType (string)

Constant value: charging_pole_3phase

Default value: charging_pole_3phase

line_currentLine Current (integer)required

The line current in Ampere.

pin_to_phase_mapping objectrequired

Defines how charging pole pins map to the collectors' phases. For more information see the 'Key Concepts - Site configuration' section in the documentation.

pin_liststring[]required

Possible values: [pin1, pin2, pin3]

phase_liststring[]required

Possible values: [L1, L2, L3]

DcChargingPole

nameName (string)required

The name of the device itself. This value will be used as the asset ID in the rest of the API.

collectorCollector (string)required

The name of the collector to which this device is connected.

typeType (string)

Constant value: dc_charging_pole

Default value: dc_charging_pole

max_powerMax Power (integer)required

The maximum power in Watt for the charging pole itself / connection to the charging pole.

ForecastedThreePhaseDevice

nameName (string)required

The name of the device itself. This value will be used as the asset ID in the rest of the API.

collectorCollector (string)required

The name of the collector to which this device is connected.

typeType (string)

Constant value: forecasted_series_3phase

Default value: forecasted_series_3phase

line_currentLine Current (integer)required

The line current in Ampere.

forecast_typeForecastTypeSiteConfiguration (string)required

Defines the type of forecast to be used for this device.

Possible values: [pv, load]

should_be_aggregatedShould Be Aggregated (boolean)

Default value: false

BessDevice

nameName (string)required

The name of the device itself. This value will be used as the asset ID in the rest of the API.

collectorCollector (string)required

The name of the collector to which this device is connected.

typeType (string)

Constant value: battery_energy_storage_system

Default value: battery_energy_storage_system

charging_efficiencyCharging Efficiency (number)

Charging efficiency of the battery [0 < x <= 1].

Possible values: > 0 and <= 1

Default value: 0.95

discharging_efficiencyDischarging Efficiency (number)

Discharging efficiency of the battery [0 < x <= 1].

Possible values: > 0 and <= 1

Default value: 0.95

maximum_charging_powerMaximum Charging Power (number)required

Maximum charging power of the battery in W.

Possible values: > 0

maximum_discharging_powerMaximum Discharging Power (number)required

Maximum discharging power of the battery in W.

Possible values: > 0

operational_battery_capacityOperational Battery Capacity (number)required

The operational battery capacity in Wh.

Possible values: > 0

charging_priorityCharging Priority (integer)

Priority of charging the battery. Default is 10

Possible values: >= 1 and <= 10

Default value: 10

discharging_priorityDischarging Priority (integer)

Priority of discharging the battery. Default is 10

Possible values: >= 1 and <= 10

Default value: 10

policies object[]

List of policies for the BESS device.

Array [

oneOf

ScheduledBessPolicy

typeType (string)

Constant value: schedule

Default value: schedule

schedule objectrequired

The schedule defining when the state of charge should be between minimum_state_of_charge and maximum_state_of_charge.

frequency

The schedule defining when the state of charge should be between minimum_state_of_charge and maximum_state_of_charge.

Possible values: [continuous, once, weekly]

continuous

object

once

date_timesstring<date-time>[]required

List of specific date-times in ISO 8601 format with timezone

Possible values: >= 1

weekly

day_of_weekDayOfWeek (string)[]required

Days of week when the schedule runs

Possible values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday], >= 1

timeTime (string)required

Time in HH:MM format (24-hour)

Possible values: Value must match regular expression ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

timezoneTimezone (string)required

IANA timezone identifier

minimum_state_of_chargeMinimum State Of Charge (number)required

The minimum state of charge to reach at the scheduled time. At each timestamp in the schedule, the state of charge will be between minimum_state_of_charge and maximum_state_of_charge.

Possible values: >= 0 and <= 100

maximum_state_of_chargeMaximum State Of Charge (number)required

The maximum state of charge to reach at the scheduled time. At each timestamp in the schedule, the state of charge will be between minimum_state_of_charge and maximum_state_of_charge.

Possible values: >= 0 and <= 100

]

]

collector_list object[]required

Array [

nameName (string)required

children object

The children of this collector. This is used to create a tree structure.

anyOf

array

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

]

null

null

phase_permutations object

If the phase naming conventions (L1, L2, L3) are not consistent between parent and child, specify the phase mapping between them.

anyOf

PinToPhasePermutation

parentstring[]required

childstring[]required

null

null

line_currentLine Current (integer)required

The line current in Ampere.

line_voltage object

The line voltage is in Volt. You should provider either line_voltage or phase_voltage (or both)

anyOf

integer

integer

null

null

phase_voltage object

The phase voltage is in Volt. You should provider either line_voltage or phase_voltage (or both)

anyOf

integer

integer

null

null

commodityCommodity (string)

Default value: electricity

1P_3PCollectorType (string)

Specifies whether the collector is single-phase (1P) or three-phase (3P).

Possible values: [1P, 3P]

Default value: 3P

nb_of_phasesNb Of Phases (integer)required

]

null

null

optimization_configuration object

anyOf

OptimizationConfiguration

peak_minimization object

anyOf

PeakMinimization

active object

Boolean field that indicates if the peak minimization is activated or not.

anyOf

boolean

boolean

null

null

peak_limit object

Specifies a line under which the peak_price does not apply. The value specified will be applied to all the phases of the collector separately. By default the peak_limit is set to 0.

anyOf

integer

integer

null

null

peak_price object

Custom peak price value. Only used when configurable_peak_price feature flag is enabled.

anyOf

number

number

null

null

null

null

negative_peak_minimization object

anyOf

PeakMinimization

active object

Boolean field that indicates if the peak minimization is activated or not.

anyOf

boolean

boolean

null

null

peak_limit object

Specifies a line under which the peak_price does not apply. The value specified will be applied to all the phases of the collector separately. By default the peak_limit is set to 0.

anyOf

integer

integer

null

null

peak_price object

Custom peak price value. Only used when configurable_peak_price feature flag is enabled.

anyOf

number

number

null

null

null

null

cost_minimization_activeCost Minimization Active (boolean)

Boolean field that indicates if cost minimization (energy price optimization) is activated or not.

Default value: true

planning_frequencyPlanning Frequency (string)

The planned frequency at which a site will be optimized. Should follow the python timedelta notation. Currently this field is disabled as we only support 15 minutes long optimization configuration. Notation is in Pandas Timedelta notation.

Constant value: PT15M

Default value: PT15M

planning_horizonPlanning Horizon (string)

The planning horizon for which the optimization will be done. Should follow the python timedelta notation. We only allow 1 day, 2 days or 3 days for now

Possible values: [P1D, P2D, P3D]

Default value: P1D

null

null

contract object

anyOf

EnergyProviderContract-Output

contract_type

Possible values: [day_night_be, dynamic, fixed]

day_night_be

day_offtake_cost_per_mwhDay Offtake Cost Per Mwh (number)required

night_offtake_cost_per_mwhNight Offtake Cost Per Mwh (number)required

day_injection_cost_per_mwhDay Injection Cost Per Mwh (number)required

night_injection_cost_per_mwhNight Injection Cost Per Mwh (number)required

dynamic

offtake_day_ahead_coefficientOfftake Day Ahead Coefficient (number)required

offtake_cost_per_mwhOfftake Cost Per Mwh (number)required

injection_day_ahead_coefficientInjection Day Ahead Coefficient (number)required

injection_cost_per_mwhInjection Cost Per Mwh (number)required

day_ahead_bidding_zoneBiddingZone (string)required

Possible values: [DE_50HZ, AL, DE_AMPRION, AT, BY, BE, BA, BG, CZ_DE_SK, HR, CWE, CY, CZ, DE_AT_LU, DE_LU, DK, DK_1, DK_1_NO_1, DK_2, DK_CA, EE, FI, MK, FR, DE, GR, HU, IS, IE_SEM, IE, IT, IT_SACO_AC, IT_CALA, IT_SACO_DC, IT_BRNN, IT_CNOR, IT_CSUD, IT_FOGN, IT_GR, IT_MACRO_NORTH, IT_MACRO_SOUTH, IT_MALTA, IT_NORD, IT_NORD_AT, IT_NORD_CH, IT_NORD_FR, IT_NORD_SI, IT_PRGP, IT_ROSN, IT_SARD, IT_SICI, IT_SUD, RU_KGD, LV, LT, LU, LU_BZN, MT, ME, GB, GE, GB_IFA, GB_IFA2, GB_ELECLINK, UK, NL, NO_1, NO_1A, NO_2, NO_2_NSL, NO_2A, NO_3, NO_4, NO_5, NO, PL_CZ, PL, PT, MD, RO, RU, SE_1, SE_2, SE_3, SE_4, RS, SK, SI, GB_NIR, ES, SE, CH, DE_TENNET, DE_TRANSNET, TR, UA, UA_DOBTPP, UA_BEI, UA_IPS, XK, DE_AMP_LU]

fixed

fixed_offtake_cost_per_mwhFixed Offtake Cost Per Mwh (number)required

fixed_injection_cost_per_mwhFixed Injection Cost Per Mwh (number)required

null

null

revenue object

anyOf

RevenueConfiguration

revenue_per_kwh_ac_charged object

Revenue per kWh charged by AC chargers in EUR.

anyOf

number

number

null

null

null

null

dso object

anyOf

DSOConnection

dsorequired

Possible values: [AIEG, AIESH, Fluvius, ORES, RESA, REW, Sibelga]

AIEG

regionRegion (string)required

Constant value: All

connection_typeConnection Type (string)required

Possible values: [T-MT avec terme capacitaire, T-MT sans terme capacitaire, MT avec terme capacitaire, MT sans terme capacitaire, T-BT avec terme capacitaire, T-BT sans terme capacitaire, BT>56kVA - heures normales, BT>56kVA - heures pleines/creuses, BT - heures normales, BT - heures pleines/creuses, BT - heures incitative]

AIESH

regionRegion (string)required

Constant value: All

connection_typeConnection Type (string)required

Possible values: [T-MT avec terme capacitaire, T-MT sans terme capacitaire, MT avec terme capacitaire, MT sans terme capacitaire, T-BT avec terme capacitaire, T-BT sans terme capacitaire, BT>56kVA - heures normales, BT>56kVA - heures pleines/creuses, BT - heures normales, BT - heures pleines/creuses, BT - heures incitative]

Fluvius

regionRegion (string)required

Possible values: [Imewo, West, Antwerpen, Midden-Vlaanderen, Zenne-Dijle, Halle-Vilvoorde, Kempen, Limburg]

connection_typeConnection Type (string)required

Possible values: [Low Voltage Network, <= 1 kV Distribution Cabine, 1-26 kV-net, 1-26 kV-post, 26-36 kV-net, 26-36 kV-post]

toegangsvermogenToegangsvermogen (number)required

ORES

regionRegion (string)required

Possible values: [Brabant Wallon, Est, Hainaut, Luxembourg, Mouscron, Namur, Verviers]

connection_typeConnection Type (string)required

Possible values: [T-MT avec terme capacitaire, T-MT sans terme capacitaire, MT avec terme capacitaire, MT sans terme capacitaire, T-BT avec terme capacitaire, T-BT sans terme capacitaire, BT>56kVA - heures normales, BT>56kVA - heures pleines/creuses, BT - heures normales, BT - heures pleines/creuses, BT - heures incitative]

RESA

regionRegion (string)required

Constant value: All

connection_typeConnection Type (string)required

Possible values: [T-MT avec terme capacitaire, T-MT sans terme capacitaire, MT avec terme capacitaire, MT sans terme capacitaire, T-BT avec terme capacitaire, T-BT sans terme capacitaire, BT>56kVA - heures normales, BT>56kVA - heures pleines/creuses, BT - heures normales, BT - heures pleines/creuses, BT - heures incitative]

REW

regionRegion (string)required

Constant value: All

connection_typeConnection Type (string)required

Possible values: [T-MT avec terme capacitaire, T-MT sans terme capacitaire, MT avec terme capacitaire, MT sans terme capacitaire, T-BT avec terme capacitaire, T-BT sans terme capacitaire, BT>56kVA - heures normales, BT>56kVA - heures pleines/creuses, BT - heures normales, BT - heures pleines/creuses, BT - heures incitative]

Sibelga

regionRegion (string)required

Constant value: Brussels Capital Region

connection_typeConnection Type (string)required

Possible values: [MT - aliment. principale, MT - aliment. secours, BT - avec mesure de pointe, BT - sans mesure de pointe <=13kVA, BT - sans mesure de pointe >13kVA, BT - sans comptage <=13kVA, BT - sans comptage >13kVA]

null

null

forecasting_configuration objectrequired

forecasted_devices object[]required

Array [

device_idDevice Id (string)required

parent_collector_idParent Collector Id (string)required

train_windowTrain Window (number)

Default value: 90

sample_sizeSample Size (number)

Default value: 900

time_fieldTime Field (string)required

forecasted_fieldForecasted Field (string)required

training_interval object

anyOf

string

string

Possible values: Value must match regular expression ^P(T?\d+.*)$

null

null

activeActive (boolean)

Default value: true

forecast_typeDeviceForecastType (string)

Possible values: [pv, load, calculated_ucl, aggregated_pv]

Default value: pv

]

ucl_calculation_activeUcl Calculation Active (boolean)required

null

null

connections objectrequired

anyOf

Connection

mqtt objectrequired

clusterCluster (string)

Default value: mqtt.pleevi.ai

energy_measurement_topicEnergy Measurement Topic (string)required

transaction_topicTransaction Topic (string)required

advice_topicAdvice Topic (string)required

notification_topicNotification Topic (string)required

null

null

Site

{
  "_id": "5eb7cf5a86d9755df3a6c593",
  "partner_id": "string",
  "site_id": "string",
  "name": "Brussels Charging Hub",
  "location": {
    "name": "Brussels Office",
    "coordinates": [
      50.8503,
      4.3517,
      0
    ]
  },
  "country": "BE",
  "active": false,
  "validation_status": {
    "status": "UNKNOWN",
    "site_configuration_status": {
      "status": "UNKNOWN",
      "configuration_added": {
        "status": "UNKNOWN"
      },
      "configuration_complete": {
        "status": "UNKNOWN",
        "missing_assets": [
          "charger-A1",
          "PV_panel_1"
        ]
      },
      "valid_for_optimization": {
        "status": "UNKNOWN",
        "validation_errors": "string"
      }
    },
    "optimization_configuration_status": {
      "status": "UNKNOWN"
    },
    "ingress_status": {
      "status": "UNKNOWN",
      "receiving_measurement_data": {
        "status": "UNKNOWN",
        "not_receiving_data_from": [
          "charger-A1"
        ]
      }
    },
    "last_validation": "2024-07-29T15:51:28.071Z"
  },
  "configurations": {
    "site_configuration": {
      "device_list": [
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "charging_pole_3phase",
          "line_current": 32,
          "pin_to_phase_mapping": {
            "pin_list": [
              "pin1"
            ],
            "phase_list": [
              "L1"
            ]
          }
        },
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "dc_charging_pole",
          "max_power": 250000
        },
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "forecasted_series_3phase",
          "line_current": 32,
          "forecast_type": "pv",
          "should_be_aggregated": false
        },
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "battery_energy_storage_system",
          "charging_efficiency": 0.95,
          "discharging_efficiency": 0.95,
          "maximum_charging_power": 50000,
          "maximum_discharging_power": 50000,
          "operational_battery_capacity": 100000,
          "charging_priority": 5,
          "discharging_priority": 5,
          "policies": [
            {
              "type": "schedule",
              "schedule": {
                "frequency": "weekly",
                "day_of_week": [
                  "monday",
                  "friday"
                ],
                "time": "09:00",
                "timezone": "America/New_York"
              },
              "minimum_state_of_charge": 20,
              "maximum_state_of_charge": 80
            }
          ]
        }
      ],
      "collector_list": [
        {
          "name": "main_collector",
          "children": [
            null
          ],
          "phase_permutations": {
            "parent": [
              "string"
            ],
            "child": [
              "string"
            ]
          },
          "line_current": 400,
          "line_voltage": 400,
          "phase_voltage": 230,
          "commodity": "electricity",
          "1P_3P": "3P",
          "nb_of_phases": 0
        }
      ]
    },
    "optimization_configuration": {
      "peak_minimization": {
        "active": true,
        "peak_limit": 100000,
        "peak_price": 100000
      },
      "negative_peak_minimization": {
        "active": true,
        "peak_limit": 100000,
        "peak_price": 100000
      },
      "cost_minimization_active": true,
      "planning_frequency": "PT15M",
      "planning_horizon": "P1D"
    },
    "contract": {
      "fixed_offtake_cost_per_mwh": 0,
      "fixed_injection_cost_per_mwh": 0,
      "contract_type": "fixed"
    },
    "revenue": {
      "revenue_per_kwh_ac_charged": 0.25
    },
    "dso": {
      "dso": "string",
      "region": "Imewo",
      "connection_type": "Low Voltage Network",
      "toegangsvermogen": 0
    },
    "forecasting_configuration": {
      "forecasted_devices": [
        {
          "device_id": "PV@main_collector",
          "parent_collector_id": "main_collector",
          "train_window": 90,
          "sample_size": 900,
          "time_field": "timestamp",
          "forecasted_field": "powerValue",
          "training_interval": "P1DT",
          "active": true,
          "forecast_type": "pv"
        }
      ]
    },
    "ucl_calculation_active": true
  },
  "connections": {
    "mqtt": {
      "cluster": "mqtt.pleevi.ai",
      "energy_measurement_topic": "pleevi/v2/partner-1/site-1/asset/<asset_id>/energyMeasurement",
      "transaction_topic": "pleevi/v2/partner-1/site-1/asset/<asset_id>/transaction",
      "advice_topic": "pleevi/v2/partner-1/site-1/asset/<asset_id>/advice",
      "notification_topic": "pleevi/v2/partner-1/site-1/notification/<event_name>"
    }
  }
}