Corrently
The Corrently ecosystem gets maintained by STROMDAO GmbH to support green energy services for prosumers, grid operators, regulators, integrators or any other party with an emerging need of consensus driven management. As the energy product Corrently got first launched in Germany parts of this documentation provide simple translations for better understanding.
Corrently endpoints
| Method | Endpoint | Description |
|---|---|---|
| Stromkonto (Ledger) | ||
| POST |
stromkontoRegister /stromkonto/register |
Calling this method with an unregistered (new) email will create a new account (Stromkonto) with all balances having a value of `0` and no transaction history. In addition some… |
| POST |
prepareTransaction /stromkonto/prepareTransaction |
Prepares and inques a transaction (transfer) between two accounts (Stromkonten). This might be used to send any balanced entity. Using this endpoint will only prepare the… |
| GET |
stromkontoChoices /stromkonto/choices |
Signable choices (contract changes) for customer. |
| GET |
stromkontoBalances /stromkonto/balances |
Stromkonto represents a core component of the Corrently Ecosystem. It is a ledger for green energy related transactions and gets heavily used by the public Web-UI on… |
| POST |
stromkontoLogin /stromkonto/login |
Sends a mail to a given email address to login this user. This function makes life a bit easier in order to not having to deal with private key protection on the user side as a… |
| GreenPowerIndex (GrünstromIndex) | ||
| GET |
gsiPrediction /gsi/prediction |
Retrieval the GreenPowerIndex (GrünstromIndex) for a given city (by zipcode) in Germany. |
| GET |
gsiMarketdata /gsi/marketdata |
Compatible to awattar (https://api.awattar.de/v1/marketdata) API interface but data comes from GreenPowerIndex instead of EPEXSpot. |
| GET |
gsiBesthour /gsi/bestHour |
Simple Wrapper around the GreenPowerIndex for easy integration into almost any SmartHome system that allows access to a JSON/REST Service This endpoint is designed to indicate if… |
| GET |
gsiDispatch /gsi/dispatch |
Dispatch of green energy has two aspects to consider: - Availability of gerneration facility (depends on weather and installed capacity) - Demand of energy Using the green power… |
| Metering (Decorator) | ||
| POST |
meteringPost /metering/reading |
Post meter reading and get it decorated. Best practice is to first create a new Stromkonto with the register method and choose a nice secret to protect updates. Now regularly… |
| GET |
meteringGet /metering/reading |
Retrieves a metered reading using account (Stromkonto). |
| Tariff (Price API) | ||
| GET |
tariffcomponents /tariff/components |
Provides insides into the different cost components of energy for a private household. Sample Request: https://api.corrently.io/v2.0/tariff/components?email=demo%40corrently.io&zi… |
| GET |
tariffSLPH0 /tariff/slph0 |
Provides pricing data for private households with standard load profiles (Standardlastprofil H0). |
| WiM (Wechselprozesse im Messwesen Strom - Status API) | ||
| GET |
wimstatus /wim/status |
Access to status information of an existing metering change and allocation process. |
| OpenMETER | ||
| GET |
omMeters /alternative/openmeter/meters |
Provides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery. |
| GET |
omActivities /alternative/openmeter/activities |
Provides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery. |
| GET |
omReadings /alternative/openmeter/readings |
Provides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery. |
| easee | ||
| GET |
easeeSessions /alternative/easee/lastSessions |
Refer to easee.cloud API for details. |
| OCPP | ||
| GET |
ocppSessions /alternative/ocpp/lastSessions |
Returns lastSession info of OCCP Cloud service for clearing in corrently ecosystem. Might be tested via [OCPP cloud simulator](https://ocpp.corrently.cloud). Last session Info of… |
| Strom-Quittung | ||
| POST |
quittungPrepare /quittung/prepare |
During the first call an account parameter will be returned within the result object. Any other parameter will be set inside the preperation. If account is put into body/request… |
| POST |
quittungComit /quittung/commit |
Uses collected fields or provided fields to create a final receipt (Strom-Quittung). |
| POST |
quittungTSE /quittung/tse |
Allows to retrieve all relevant data assiciated to a TSE service call. E.q. Input parameters, public key and signature. |
| POST |
quittungCreate /quittung/create |
Creates a full featured receipt (Quittung) for an energy delivery as it appears on a charging session or similar events. Allows to embed receipt generation directly into external… |
| GET |
quittungZugferd /quittung/zugferd |
Allows to retrieve XML of the zugferd invoice. |
| POST |
quittungTSEsignature /quittung/tsesignature |
Allows to retrieve digital signature for a given receipt. |
| POST |
quittungTSEData /quittung/tsedata |
Allows to retrieve input string for a signing process. |
| CO2-Offset | ||
| GET |
co2price /co2/price |
All CO2 offset prices are based on VCS Verified CO2 Emission Reduction In accordance with the requirements of ISO 14064-1. CO2 prices are actual market prices and may change… |
| GET |
co2sources /co2/sources |
Valid and certified sources of co2 compensation. |
| GET |
co2compensate /co2/compensate |
You might call the /price API endpoint prior to a checkout to get latest pricing information. This method returns a URL for direct checkout using Stripe. All CO2 offset prices… |
Corrently pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | 1 / minute |
|
| PRO | $15 / month | — |
|
| ULTRA | $200 / month | 1 / second |
|