SiteCreateDTO

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

configurations object

anyOf

Configurations

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]

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: [once, weekly]

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)required

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

Possible values: [1P, 3P]

]

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

integer

integer

null

null

null

null

cost_minimization object

anyOf

CostMinimization

activeActive (boolean)

Default value: false

day_ahead_price object

anyOf

boolean

boolean

null

null

day_ahead_bidding_zone object

anyOf

BiddingZone

string

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]

null

null

fixed_offtake_price object

The offtake price in Mega Watt per hour. This is the price electricity is taken from the grid.

anyOf

number

number

null

null

injection_price object

Price at which electricity can be injected back into to grid in Mega Watt per hour.

anyOf

integer

integer

null

null

null

null

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

null

null

SiteCreateDTO

{
  "site_id": "string",
  "name": "string",
  "location": {
    "name": "string",
    "coordinates": [
      null
    ]
  },
  "country": "string",
  "active": false,
  "configurations": {
    "site_configuration": {
      "device_list": [
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "charging_pole_3phase",
          "line_current": 0,
          "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": 0,
          "forecast_type": "pv"
        },
        {
          "name": "LR34_001",
          "collector": "main_collector",
          "type": "battery_energy_storage_system",
          "charging_efficiency": 0.95,
          "discharging_efficiency": 0.95,
          "maximum_charging_power": 0,
          "maximum_discharging_power": 0,
          "operational_battery_capacity": 0,
          "charging_priority": 10,
          "discharging_priority": 10,
          "policies": [
            {
              "type": "schedule",
              "schedule": {
                "frequency": "weekly",
                "day_of_week": [
                  "monday",
                  "friday"
                ],
                "time": "09:00",
                "timezone": "America/New_York"
              },
              "minimum_state_of_charge": 85.49,
              "maximum_state_of_charge": 85.49
            }
          ]
        }
      ],
      "collector_list": [
        {
          "name": "string",
          "children": [
            null
          ],
          "phase_permutations": {
            "parent": [
              "string"
            ],
            "child": [
              "string"
            ]
          },
          "line_current": 0,
          "line_voltage": 0,
          "phase_voltage": 0,
          "commodity": "electricity",
          "1P_3P": "1P"
        }
      ]
    },
    "optimization_configuration": {
      "peak_minimization": {
        "active": true,
        "peak_limit": 0,
        "peak_price": 0
      },
      "cost_minimization": {
        "active": false,
        "day_ahead_price": true,
        "day_ahead_bidding_zone": "DE_50HZ",
        "fixed_offtake_price": 0,
        "injection_price": 0
      },
      "planning_frequency": "PT15M",
      "planning_horizon": "P1D"
    }
  }
}