Skip to main content

SolisCloud API wrapper for python

Project description

soliscloud-api

Python implementation for the SolisCloud API

Supports all endpoints specified in SolisCloud API spec 2.0 for reading Solis PV monitoring data from the SolisCloud service.

Prerequisites

Usage of the API requires an active account on https://www.soliscloud.com and also requires an API key and secret, to be obtained via SolisCloud.

  • Submit a service ticket and wait till it is resolved.
  • Go to https://www.soliscloud.com/#/apiManage.
  • Activate API management and agree with the usage conditions.
  • After activation, click on view key tot get a pop-up window asking for the verification code.
  • First click on "Verification code" after which you get an image with 2 puzzle pieces, which you need to overlap each other using the slider below.
  • After that, you will receive an email with the verification code you need to enter (within 60 seconds).
  • Once confirmed, you get the API ID, secret and API URL

Supported API calls

NOTE: The spec uses the terms Plant, Station and Power Station interchangeably. In this document we will use plant.

Call Description
/v1/api/inverterList Obtain list of all inverters under account or a specific plant.
/v1/api/inverterDetail Obtain details for a single inverter.
/v1/api/inverterDetailList Obtain list of details of all inverters under account.
/v1/api/inverterDay Obtain real-time data of a single inverter on the specified day.
/v1/api/inverterMonth Obtain daily data of a single inverter for the specified month.
/v1/api/inverterYear Obtain monthly data of a single inverter for the specified year.
/v1/api/inverterAll Obtain cumulative data of a single inverter for the current year.
/v1/api/inverter/shelfTime :new: Warranty data of a single inverter.
/v1/api/alarmList Obtain device alarm list of all or specific inverter under account.
/v1/api/collectorList Obtain list of all collectors under account or for a specific plant.
/v1/api/collectorDetail Obtain details for a single collector.
/v1/api/collector/day :new: Obtain daily data for a single collector.
/v1/api/epmList Obtain list of all EPM's under account or for a specific plant.
/v1/api/epmDetail Obtain details for a single EPM.
/v1/api/epm/day Obtain real-time data of a single EPM on the specified day.
/v1/api/epm/month Obtain daily data of a single EPM for the specified month.
/v1/api/epm/year Obtain monthly data of a single EPM for the specified year.
/v1/api/epm/all Obtain cumulative data of a single EPM for the current year.
/v1/api/weatherList :new: Obtain list of all meteorological instruments under account or for a specific plant.
/v1/api/weatherDetail :new: Obtain details for a single meteorological instrument.
/v1/api/userStationList Obtain list of all plants under account.
/v1/api/stationDetail Obtain details for a single plant.
/v1/api/stationDetailList Obtain details for a all plants under account.
/v1/api/stationDayEnergyList Obtain real-time data of a single or all plants on the specified day.
/v1/api/stationMonthEnergyList Obtain daily data of a single or all plants for the specified month.
/v1/api/stationYearEnergyList Obtain monthly data of a single or all plants for the specified year.
/v1/api/stationDay Obtain real-time data of a single plant on the specified day.
/v1/api/stationMonth Obtain daily data of a single plant for the specified month.
/v1/api/stationYear Obtain monthly data of a single plant for the specified year.
/v1/api/stationAll Obtain cumulative data of a single plant for the current year.

Currently unsupported API calls

Call Description
/v1/api/addStation Add a plant to the account.
/v1/api/stationUpdate Update plant information.
/v1/api/addStationBindCollector Binding a new collector to the plant.
/v1/api/delCollector Unbind a collector from the plant.
/v1/api/addDevice Binding a new inverter to the plant.

Known issues

  1. If the local time deviates more than 15 minutes from SolisCloud server time then the server will respond with HTTP 408.
  2. When calls to the API return with error message "数据异常 请联系管理员" (English: abnormal data, please contact administrator.), then SolisCloud helpdesk needs to fix your account, raise a ticket via soliscloud.com
  3. I could not test the use of the NMI parameter for AUS use cases, please create a ticket or pull request if you experience issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soliscloud_api-1.3.2.tar.gz (684.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

soliscloud_api-1.3.2-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file soliscloud_api-1.3.2.tar.gz.

File metadata

  • Download URL: soliscloud_api-1.3.2.tar.gz
  • Upload date:
  • Size: 684.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for soliscloud_api-1.3.2.tar.gz
Algorithm Hash digest
SHA256 a9161e75990a374062a104360b11a161c5e716f5398438cb7a50be34b48405cd
MD5 c9dc1b16a18fb443fbb6edf1b4b8c690
BLAKE2b-256 badfe62fbd5c79dd553788db90bcd16a84674d96c026611a123e94ee15f87c2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for soliscloud_api-1.3.2.tar.gz:

Publisher: python-publish.yml on hultenvp/soliscloud_api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file soliscloud_api-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: soliscloud_api-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for soliscloud_api-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3186c680f618dbbf990798a4f91c9afabeb1444b7f840addd8f88151fea4125f
MD5 d429535dff5ba433a9ad2c2fec4cdb3f
BLAKE2b-256 8eb27de5487bfe7761a3070eda55f1534d4dd99cce42811dc6ef7e4227c71659

See more details on using hashes here.

Provenance

The following attestation bundles were made for soliscloud_api-1.3.2-py3-none-any.whl:

Publisher: python-publish.yml on hultenvp/soliscloud_api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page