SolarEdge (Independent Publisher) (Preview)

The SolarEdge connector gives you the oppurtunity to display system data in other applications

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Richard Wierenga
URL	https://knowledge-center.solaredge.com/
Email	rwconnectors@gmail.com

Connector Metadata
Publisher	Richard Wierenga
Website	https://www.solaredge.com/
Privacy policy	https://monitoring.solaredge.com/solaredge-web/p/license
Categories	Internet of Things;Data

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
api_key	securestring	The api_key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Components List	Return a list of inverters/SMIs in the specific site
Equipment Change Log	Returns a list of equipment component replacements ordered by date. This method is applicable to inverters, optimizers, batteries and gateways.
Get Meters Data	Returns for each meter on site its lifetime energy reading, metadata and the device to which it’s connected to.
Get Sensor List	Returns a list of all the sensors in the site, and the device to which they are connected
Inverter Technical Data	Return specific inverter data for a given timeframe.
Site Details	Displays the site details, such as name, location, status, etc.
Site energy	Return the site energy measurements
Site Energy - Detailed	Detailed site energy measurements from meters such as consumption, export (feed-in), import (purchase), etc.
Site Energy – Time Period	Return the site total energy produced for a given period.
Site Environmental Benefits	Returns all environmental benefits based on site energy production: CO2 emissions saved, equivalent trees planted, and light bulbs powered for a day.
Site Inventory	Return the inventory of SolarEdge equipment in the site, including inverters/SMIs, batteries, meters, gateways and sensors.
Site Overview	The response includes the site current power, daily energy, monthly energy, yearly energy and life time energy.
Site power	Return the site power measurements in 15 minutes resolution
Site Power - Detailed	Detailed site power measurements from meters such as consumption, export (feed-in), import (purchase), etc.
Site Power Flow	Retrieves the current power flow between all elements of the site including PV array, storage (battery), loads (consumption) and grid.
Sites List	Returns a list of sites related to the given token, which is the account api_key. This API accepts parameters for convenient search, sort and pagination.
Storage Information	Get detailed storage information from batteries: the state of energy, power and lifetime energy.

Components List

Operation ID:

ComponentsList

Return a list of inverters/SMIs in the specific site

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
count	reporters.count	integer	The sites component count
list	reporters.list	array of object	list
componentname	reporters.list.componentname	string	The component name
manufacturer	reporters.list.manufacturer	string	The component manufacturer
Model	reporters.list.Model	string	The component model
SerialNumber	reporters.list.SerialNumber	string	The component serialNumber

Equipment Change Log

Operation ID:

EquipmentChangeLog

Returns a list of equipment component replacements ordered by date. This method is applicable to inverters, optimizers, batteries and gateways.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
The serial number of the equipment	equipment_id	True	string	The serial number of the equipment

Returns

Name	Path	Type	Description
count	ChangeLog.count	integer	count
serialNumber	ChangeLog.list.serialNumber	string	Equipment short serial number
partNumber	ChangeLog.list.partNumber	string	inverter/battery/optimizer/gateway model
date	ChangeLog.list.date	string	Date of replacement of that equipment component

Get Meters Data

Operation ID:

GetMetersData

Returns for each meter on site its lifetime energy reading, metadata and the device to which it’s connected to.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
Aggregation granularity	timeUnit		string	Aggregation granularity, allowed values are QUARTER_OF_AN_HOUR, HOUR, DAY, WEEK, MONTH, YEAR
The energy measured start time in yyyy-MM-DD hh:mm:ss format	startTime	True	string	The energy measured start time in yyyy-MM-DD hh:mm:ss format
The energy measured end time in yyyy-MM-DD hh:mm:ss format	endTime	True	string	The energy measured end time in yyyy-MM-DD hh:mm:ss format
Select specific meters only	meters		string	Select specific meters only. If this value is omitted, all meter readings are returned. Allowed values are Production, Consumption, FeedIn, Purchased

Returns

Name	Path	Type	Description
timeUnit	meterEnergyDetails.timeUnit	string	Aggregation granularity
unit	meterEnergyDetails.unit	string	Returned meters unit (Wh)
meters	meterEnergyDetails.meters	array of object	Values per meter
meterSerialNumber	meterEnergyDetails.meters.meterSerialNumber	string	meterSerialNumber
connectedSolaredgeDeviceSN	meterEnergyDetails.meters.connectedSolaredgeDeviceSN	string	Inverter to which the meter is connected to
model	meterEnergyDetails.meters.model	string	Meter model
meterType	meterEnergyDetails.meters.meterType	string	Meter type Production, Consumption, FeedIn or Purchased
values	meterEnergyDetails.meters.values	array of object	Values per meter per date
date	meterEnergyDetails.meters.values.date	string	Measurement timestamp
value	meterEnergyDetails.meters.values.value	float	Lifetime energy reading

Get Sensor List

Operation ID:

GetSensorList

Returns a list of all the sensors in the site, and the device to which they are connected

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
count	SiteSensors.count	integer	The sites sensor count
list	SiteSensors.list	array of object	List per gateway
connectedTo	SiteSensors.list.connectedTo	string	Name of the gateway the sensor is connected to
count	SiteSensors.list.count	integer	The gateways sensor count
sensors	SiteSensors.list.sensors	array of object	sensors
name	SiteSensors.list.sensors.name	string	Sensor name
measurement	SiteSensors.list.sensors.measurement	string	What the sensor measures, e.g. SensorGlobalHorizontalIrradiance, SensorDiffusedIrradiance, SensorAmbientTemperature
type	SiteSensors.list.sensors.type	string	what the sensor measures, e.g. SensorGlobalHorizontalIrradiance, SensorDiffusedIrradiance, SensorAmbientTemperature

Inverter Technical Data

Operation ID:

InverterTechnicalData

Return specific inverter data for a given timeframe.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
The serial number of the equipment	equipment_id	True	string	The serial number of the equipment
The start (date + time) to get inverter data	startTime	True	string	The start (date + time) to get inverter data
The end (date + time) to get inverter data	endTime	True	string	The end (date + time) to get inverter data

Returns

Name	Path	Type	Description
count	data.count	integer	Count of responses
telemetries	data.telemetries	array of object	telemetries
threePhaseInverterTelemetry	data.telemetries.threePhaseInverterTelemetry	array of object	threePhaseInverterTelemetry
date	data.telemetries.threePhaseInverterTelemetry.date	string	date
totalActivePower	data.telemetries.threePhaseInverterTelemetry.totalActivePower	string	totalActivePower
dcVoltage	data.telemetries.threePhaseInverterTelemetry.dcVoltage	float	dcVoltage
groundFaultResistance	data.telemetries.threePhaseInverterTelemetry.groundFaultResistance	float	groundFaultResistance
powerLimit	data.telemetries.threePhaseInverterTelemetry.powerLimit	float	powerLimit
totalEnergy	data.telemetries.threePhaseInverterTelemetry.totalEnergy	integer	totalEnergy
temperature	data.telemetries.threePhaseInverterTelemetry.temperature	float	Temperature in Celsius
inverterMode	data.telemetries.threePhaseInverterTelemetry.inverterMode	string	State of the inverter i.e. OFF, STARTING, MPPT etc.
operationMode	data.telemetries.threePhaseInverterTelemetry.operationMode	integer	Operation mode integer 0 On-grid, 1 Operating in off-grid mode with PV or Battery, 2 operating in off-grid mode with generator
acCurrent	data.telemetries.threePhaseInverterTelemetry.L1Data.acCurrent	float	acCurrent
acVoltage	data.telemetries.threePhaseInverterTelemetry.L1Data.acVoltage	float	acVoltage
acFrequency	data.telemetries.threePhaseInverterTelemetry.L1Data.acFrequency	float	acFrequency
apparentPower	data.telemetries.threePhaseInverterTelemetry.L1Data.apparentPower	integer	apparentPower
activePower	data.telemetries.threePhaseInverterTelemetry.L1Data.activePower	integer	activePower
reactivePower	data.telemetries.threePhaseInverterTelemetry.L1Data.reactivePower	integer	reactivePower
cosPhi	data.telemetries.threePhaseInverterTelemetry.L1Data.cosPhi	integer	cosPhi
vL1To2	data.telemetries.threePhaseInverterTelemetry.vL1To2	float	vL1To2
vL2To3	data.telemetries.threePhaseInverterTelemetry.vL2To3	float	vL2To3
vL3To1	data.telemetries.threePhaseInverterTelemetry.vL3To1	float	vL3To1
acCurrent	data.telemetries.threePhaseInverterTelemetry.L2Data.acCurrent	float	acCurrent
acVoltage	data.telemetries.threePhaseInverterTelemetry.L2Data.acVoltage	float	acVoltage
acFrequency	data.telemetries.threePhaseInverterTelemetry.L2Data.acFrequency	float	acFrequency
apparentPower	data.telemetries.threePhaseInverterTelemetry.L2Data.apparentPower	integer	apparentPower
activePower	data.telemetries.threePhaseInverterTelemetry.L2Data.activePower	integer	activePower
reactivePower	data.telemetries.threePhaseInverterTelemetry.L2Data.reactivePower	integer	reactivePower
cosPhi	data.telemetries.threePhaseInverterTelemetry.L2Data.cosPhi	integer	cosPhi
acCurrent	data.telemetries.threePhaseInverterTelemetry.L3Data.acCurrent	float	acCurrent
acVoltage	data.telemetries.threePhaseInverterTelemetry.L3Data.acVoltage	float	acVoltage
acFrequency	data.telemetries.threePhaseInverterTelemetry.L3Data.acFrequency	float	acFrequency
apparentPower	data.telemetries.threePhaseInverterTelemetry.L3Data.apparentPower	integer	apparentPower
activePower	data.telemetries.threePhaseInverterTelemetry.L3Data.activePower	integer	activePower
reactivePower	data.telemetries.threePhaseInverterTelemetry.L3Data.reactivePower	integer	reactivePower
cosPhi	data.telemetries.threePhaseInverterTelemetry.L3Data.cosPhi	integer	cosPhi

Site Details

Operation ID:

SiteDetails

Displays the site details, such as name, location, status, etc.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
id	details.id	integer	The site ID
name	details.name	string	The site name
accountId	details.accountId	integer	The account this site belongs to
status	details.status	string	The sites status
peakPower	details.peakPower	float	The sites peakPower
currency	details.currency	string	The sites currency
installationDate	details.installationDate	string	Site installation datetime, format yyyy-mm-dd hh:mm:ss
ptoDate	details.ptoDate	string	Permission to operate date
notes	details.notes	string	Notes
type	details.type	string	Site type
country	details.location.country	string	The sites country
city	details.location.city	string	The sites city
address	details.location.address	string	The sites address
address2	details.location.address2	string	The sites address2
zip	details.location.zip	string	The sites zip
timeZone	details.location.timeZone	string	The sites timeZone
countryCode	details.location.countryCode	string	The sites country Code
alertQuantity	details.alertQuantity	integer	Number of open alerts in this site
alertSeverity	details.alertSeverity	string	The highest alert severity in this site
IMAGE_URI	details.uris.IMAGE_URI	string	The sites image uri

Site energy

Operation ID:

SiteEnergy

Return the site energy measurements

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
Aggregation granularity	timeUnit	True	string	Aggregation granularity, allowed values are QUARTER_OF_AN_HOUR, HOUR, DAY, WEEK, MONTH, YEAR
The start date to return energy measurement	startDate	True	string	The start date to return energy measurement
The end date return energy measurement	endDate	True	string	The end date return energy measurement

Returns

Name	Path	Type	Description
timeUnit	energy.timeUnit	string	Requested time unit
unit	energy.unit	string	The units of measurement
measuredBy	energy.measuredBy	string	Source of measurements
values	energy.values	array of object	Measurements
date	energy.values.date	string	Datetime
value	energy.values.value	float	Measured power(i.e. Watt) at specified datetime

Site Energy - Detailed

Operation ID:

SiteEnergyDetailed

Detailed site energy measurements from meters such as consumption, export (feed-in), import (purchase), etc.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
Aggregation granularity	timeUnit	True	string	Aggregation granularity, allowed values are QUARTER_OF_AN_HOUR, HOUR, DAY, WEEK, MONTH, YEAR
The energy measured start time in yyyy-MM-DD hh:mm:ss format	startTime	True	string	The energy measured start time in yyyy-MM-DD hh:mm:ss format
The energy measured end time in yyyy-MM-DD hh:mm:ss format	endTime	True	string	The energy measured end time in yyyy-MM-DD hh:mm:ss format
Select specific meters only	Meters	True	string	Select specific meters only, if blank everything is returned. Allowed values are PRODUCTION, CONSUMPTION, SelfConsumption, FeedIn, Purchased

Returns

Name	Path	Type	Description
timeUnit	energyDetails.timeUnit	string	Requested time unit
unit	energyDetails.unit	string	The units of measurement
meters	energyDetails.meters	array of object	meters
type	energyDetails.meters.type	string	type
values	energyDetails.meters.values	array of object	values
date	energyDetails.meters.values.date	string	Datetime
value	energyDetails.meters.values.value	float	Measured power(i.e. Watt) at specified datetime

Site Energy – Time Period

Operation ID:

SiteEnergyTimePeriod

Return the site total energy produced for a given period.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
The start date to return energy measurement	startDate	True	string	The start date to return energy measurement
The end date return energy measurement	endDate	True	string	The end date return energy measurement

Returns

Name	Path	Type	Description
energy	timeFrameEnergy.energy	float	Energy summary
unit	timeFrameEnergy.unit	string	Energy unit (Wh)
measuredBy	timeFrameEnergy.measuredBy	string	The source of the measurements
date	timeFrameEnergy.startLifetimeEnergy.date	string	Supplied start date information
energy	timeFrameEnergy.startLifetimeEnergy.energy	float	Start date energy
unit	timeFrameEnergy.startLifetimeEnergy.unit	string	Start date unit (Wh)
date	timeFrameEnergy.endLifetimeEnergy.date	string	Supplied end date information
energy	timeFrameEnergy.endLifetimeEnergy.energy	float	End date energy
unit	timeFrameEnergy.endLifetimeEnergy.unit	string	End date unit (Wh)

Site Environmental Benefits

Operation ID:

SiteEnvironmentalBenefits

Returns all environmental benefits based on site energy production: CO2 emissions saved, equivalent trees planted, and light bulbs powered for a day.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
units	envBenefits.gasEmissionSaved.units	string	units for the rest of the results
co2	envBenefits.gasEmissionSaved.co2	float	Co2 in Kg or Lb
so2	envBenefits.gasEmissionSaved.so2	float	So2 in Kg or Lb
nox	envBenefits.gasEmissionSaved.nox	float	NOX in Kg or Lb
treesPlanted	envBenefits.treesPlanted	float	Equivalent planting of new trees for reducing CO2 levels
lightBulbs	envBenefits.lightBulbs	float	number of light bulbs that could have been powered by the site for a day

Site Inventory

Operation ID:

SiteInventory

Return the inventory of SolarEdge equipment in the site, including inverters/SMIs, batteries, meters, gateways and sensors.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
meters	Inventory.meters	array of object	List of meters for specified site
name	Inventory.meters.name	string	Meter name
manufacturer	Inventory.meters.manufacturer	string	Meter manufacturer
model	Inventory.meters.model	string	Meter model
firmwareVersion	Inventory.meters.firmwareVersion	string	Meter firmwareVersion
connectedSolaredgeDeviceSN	Inventory.meters.connectedSolaredgeDeviceSN	string	– Name of SolarEdge device the meter is connected to
type	Inventory.meters.type	string	Meter type e.g. “Production”
form	Inventory.meters.form	string	physical for a HW meter or virtual if calculated by arithmetic between other meters
sensors	Inventory.sensors	array of object	List of sensors for specified site
connectedSolaredgeDeviceSN	Inventory.sensors.connectedSolaredgeDeviceSN	string	– Name of SolarEdge device the sensor is connected to
id	Inventory.sensors.id	string	Sensor id
connectedTo	Inventory.sensors.connectedTo	string	name of the device it is connected to e.g. "Gateway 1"
category	Inventory.sensors.category	string	Sensor category e.g. IRRADIANCE
type	Inventory.sensors.type	string	Sensor type e.g. “Plane of array irradiance”
gateways	Inventory.gateways	array of object	List of gateways for specified site
name	Inventory.gateways.name	string	The inverter name e.g. Inverter 1
firmwareVersion	Inventory.gateways.firmwareVersion	string	The equipment firmwareversion
SN	Inventory.gateways.SN	string	The equipment serial number e.g. 7F123456-00
batteries	Inventory.batteries	array of object	List of batteries for specified site
name	Inventory.batteries.name	string	The battery name
manufacturer	Inventory.batteries.manufacturer	string	The battery manufacturer
model	Inventory.batteries.model	string	The battery model
firmwareVersion	Inventory.batteries.firmwareVersion	string	The battery firmwareVersion
connectedInverterSn	Inventory.batteries.connectedInverterSn	string	– serial number of the inverter / gateway the battery is connected to
nameplateCapacity	Inventory.batteries.nameplateCapacity	integer	the nameplate capacity of the battery as provided by the manufacturer
SN	Inventory.batteries.SN	string	Serial number of the battery
inverters	Inventory.inverters	array of object	List of inverters for specified site
name	Inventory.inverters.name	string	The inverter name
manufacturer	Inventory.inverters.manufacturer	string	The inverter manufacturer
model	Inventory.inverters.model	string	The inverter model
firmwareVersion	Inventory.inverters.firmwareVersion	string	The inverter firmwareVersion
SN	Inventory.inverters.SN	string	The inverter serialnumber
connectedOptimizers	Inventory.inverters.connectedOptimizers	integer	Number of optimizers connected to the inverter

Site Overview

Operation ID:

SiteOverview

The response includes the site current power, daily energy, monthly energy, yearly energy and life time energy.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
lastUpdateTime	overview.lastUpdateTime	string	lastUpdateTime
energy	overview.lifeTimeData.energy	float	Lifetime energy number
energy	overview.lastYearData.energy	float	Last year energy number
energy	overview.lastMonthData.energy	float	Energy number
energy	overview.lastDayData.energy	float	Last day energy number
power	overview.currentPower.power	float	Current power number
measuredBy	overview.measuredBy	string	Measured by

Site power

Operation ID:

SitePower

Return the site power measurements in 15 minutes resolution

Parameters

Name	Key	Required	Type	Description
The start date and time	startTime	True	string	The start date and time (yyyy-mm-dd hh:mm:ss) to get power measurements
The start date and time	endTime	True	string	The start date and time (yyyy-mm-dd hh:mm:ss) to get power measurements
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
timeUnit	power.timeUnit	string	Time unit (i.e. QUARTER_OF_AN_HOUR)
unit	power.unit	string	Measurement unit (i.e. Watt)
measuredBy	power.measuredBy	string	Source of measurements
values	power.values	array of object	Measurements
date	power.values.date	string	Datetime
value	power.values.value	float	Measured power(i.e. Watt) at specified datetime

Site Power - Detailed

Operation ID:

SitePowerDetailed

Detailed site power measurements from meters such as consumption, export (feed-in), import (purchase), etc.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
The energy measured start time	startTime	True	string	The energy measured start time in yyyy-MM-DD hh:mm:ss format
The energy measured end time	endTime	True	string	The energy measured end time in yyyy-MM-DD hh:mm:ss format

Returns

Name	Path	Type	Description
timeUnit	powerDetails.timeUnit	string	Requested time unit
unit	powerDetails.unit	string	The units of measurements
meters	powerDetails.meters	array of object	Meters
type	powerDetails.meters.type	string	The meter type (Production/Consumption/SelfConsumption/FeedIn (export)/Purchased(import))
values	powerDetails.meters.values	array of object	Pairs of date and power for every date
date	powerDetails.meters.values.date	string	Datetime
value	powerDetails.meters.values.value	float	Power for specified datetime

Site Power Flow

Operation ID:

SitePowerFlow

Retrieves the current power flow between all elements of the site including PV array, storage (battery), loads (consumption) and grid.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier

Returns

Name	Path	Type	Description
unit	siteCurrentPowerFlow.unit	string	The measurement units (e.g. Watt)
connections	siteCurrentPowerFlow.connections	array of object	A table including all the relationships between the elements, and the power flow directions (producing element and consuming element)
from	siteCurrentPowerFlow.connections.from	string	The element providing power
to	siteCurrentPowerFlow.connections.to	string	The element consuming power
status	siteCurrentPowerFlow.GRID.status	string	Grid status (Active / Idle/ Disabled)
currentPower	siteCurrentPowerFlow.GRID.currentPower	float	current grid Power
status	siteCurrentPowerFlow.LOAD.status	string	Load status (Active / Idle/ Disabled)
currentPower	siteCurrentPowerFlow.LOAD.currentPower	float	current load Power
status	siteCurrentPowerFlow.PV.status	string	PV status (Active / Idle/ Disabled)
currentPower	siteCurrentPowerFlow.PV.currentPower	float	current PV Power
status	siteCurrentPowerFlow.STORAGE.status	string	Storage status (Active / Idle/ Disabled)
currentPower	siteCurrentPowerFlow.STORAGE.currentPower	float	current storage Power
chargeLevel	siteCurrentPowerFlow.STORAGE.chargeLevel	integer	Storage chargeLevel
critical	siteCurrentPowerFlow.STORAGE.critical	boolean	Storage critical?
timeLeft	siteCurrentPowerFlow.STORAGE.timeLeft	integer	In backup mode, specified time before storage runs out

Sites List

Operation ID:

SitesList

Returns a list of sites related to the given token, which is the account api_key. This API accepts parameters for convenient search, sort and pagination.

Returns

Name	Path	Type	Description
count	sites.count	integer	The amount of sites that are returned.
site	sites.site	array of object	site
SiteID	sites.site.id	integer	The site ID.
name	sites.site.name	string	The site name
accountId	sites.site.accountId	integer	The account this site belongs to
status	sites.site.status	string	The site status
peakPower	sites.site.peakPower	float	Site peak power
lastUpdateTime	sites.site.lastUpdateTime	string	Site last update datetime, format yyyy-mm-dd hh:mm:ss
installationDate	sites.site.installationDate	string	Site installation datetime, format yyyy-mm-dd hh:mm:ss
ptoDate	sites.site.ptoDate	string	Permission to operate date
notes	sites.site.notes	string	Notes
type	sites.site.type	string	Site type
country	sites.site.location.country	string	The sites country
city	sites.site.location.city	string	The sites city
address	sites.site.location.address	string	The sites address
address2	sites.site.location.address2	string	The sites address2
zip	sites.site.location.zip	string	The sites zip
timeZone	sites.site.location.timeZone	string	The sites timeZone
countryCode	sites.site.location.countryCode	string	The sites country Code
manufacturerName	sites.site.primaryModule.manufacturerName	string	Primary model manufacturerName
modelName	sites.site.primaryModule.modelName	string	Primary model modelName
maximumPower	sites.site.primaryModule.maximumPower	float	Primary model maximumPower
temperatureCoef	sites.site.primaryModule.temperatureCoef	float	Primary model temperatureCoef

Storage Information

Operation ID:

StorageInformation

Get detailed storage information from batteries: the state of energy, power and lifetime energy.

Parameters

Name	Key	Required	Type	Description
The site identifier	site_id	True	integer	The site identifier
The site identifier	startTime	True	string	The site identifier
The site identifier	endTime	True	string	The site identifier
Return data only for specific battery serial numbers	serials		string	Return data only for specific battery serial numbers, the list is comma separated. If omitted, the response includes all the batteries in the site

Returns

Name	Path	Type	Description
batteryCount	storageData.batteryCount	integer	Number of batteries includes in the response
batteries	storageData.batteries	array of object	A list of battery objects
nameplate	storageData.batteries.nameplate	integer	The nameplate (nominal) capacity of the battery
serialNumber	storageData.batteries.serialNumber	string	The battery serial number
modelNumber	storageData.batteries.modelNumber	string	Battery model number
telemetryCount	storageData.batteries.telemetryCount	integer	The number of telemetries for this battery in the response
telemetries	storageData.batteries.telemetries	array of object	A list of storage data telemetries
timeStamp	storageData.batteries.telemetries.timeStamp	string	Telemetry timestamp in the format of YYYY-MM-DD HH:MM:SS
power	storageData.batteries.telemetries.power	integer	Positive power indicates the battery is charging, negative is discharging
batteryState	storageData.batteries.telemetries.batteryState	integer	Can be one of the following 0 (Invalid), 1 (Standby), 2 (Thermal Mgmt.), 3 (Enabled), 4 (Fault)
lifeTimeEnergyCharged	storageData.batteries.telemetries.lifeTimeEnergyCharged	float	The energy Charged from the battery in Wh, during battery lifetime
lifeTimeEnergyDischarged	storageData.batteries.telemetries.lifeTimeEnergyDischarged	float	The energy discharged from the battery in Wh, during battery lifetime
fullPackEnergyAvailable	storageData.batteries.telemetries.fullPackEnergyAvailable	integer	The maximum energy (Wh) that can currently be stored in the battery
internalTemp	storageData.batteries.telemetries.internalTemp	integer	Battery internal temperature in Celsius
ACGridCharging	storageData.batteries.telemetries.ACGridCharging	integer	Amount of AC energy used to charge the battery from grid within a specified date range in Wh
stateOfCharge	storageData.batteries.telemetries.stateOfCharge	integer	the battery state of charge as percentage of the available capacity. Values are in the range of 0 to 100