VCOM Cloud
English German
English German

SolarEdge API

Last modified:

Set up SolarEdge API

📗

General tips

  • Serial number: Have the data source (data logger, etc.) serial number on hand. When entering the serial number, pay attention to uppercase and lowercase letters and empty spaces.

  • Name: In most cases, the data source name can be freely selected. For recommendations, see our Naming guideline.

  • Multiple data sources: If possible, use data sources that support the same measuring interval or align the intervals if possible. Otherwise, minor features may not work properly. See also Measuring interval.

  • Automatic device creation: This will automatically create new devices in the system, such as inverters or batteries, as soon as their data is included in a new import file. It is not possible to manually create these devices. In rare exceptional cases, for example, if the devices are already included in another system, you do not need to tick this checkbox.

  • Connection test: If possible, perform a connection test once you have completed the configuration in both VCOM and the data source.

Data loggers only

  • For data loggers, update the firmware to the latest version prior to configuration.

  • For data loggers, any import that uses FTP can also use SFTP. The access data, such as the FTP server address, user name, and password remain identical. Only the port changes from port 21 (FTP) to port 2222 (SFTP).

APIs only

  • If you experience import issues with the API, please contact the respective API provider first.

  • Each day at midnight, VCOM checks for complete data and requests data from the past 7 days. If there are no limitations from the API and the data is available, the gaps will be filled.

Configuration details

Protocol

HTTPS Pull

File format

JSON

Transmission interval (pull)

hourly

Solaredge API key

Found in the SolarEdge portal. If you choose to use the free API key, we recommend adjusting the import hourly interval to stay within rate limits.

For an entire park, navigate to:

  • Account admin > Company details tab > API access

For an individual site, navigate to:

  • Site admin > Site access tab > Access control tab > API access

Configuration: VCOM

Warning

If you are using the SolarEdge API V1, you must switch to V2 by November 3, 2026. Important change: weather sensors are no longer available as devices.

Prerequisites

  • User group technical customer or higher

Steps

  1. At system level , go to  icon-wrench1.png System settings > icon-database-insert.png Data sources > Data logger overview.

  2. Under New source of type, select SolarEdge API.

  3. Select Add.

  4. Enter the Data logger name and Hardware serial number.

  5. Select the Measuring interval.

  6. Enter the Site id.

  7. Under API key V2, enter your SolarEdge API key.

  8. Select Register new data logger.

Last updated: