Corrently.io
Corrently - from italian corrente, which is energy
Introduction
The Corrently ecosystem gets maintained by 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 got first launched in Germany parts of this documentation provide simple translations for better understanding.
- Homepage
- https://api.apis.guru/v2/specs/corrently.io/2.0.0.json
- Provider
- corrently.io
- OpenAPI version
- 3.0.2
- Spec (JSON)
- https://api.apis.guru/v2/specs/corrently.io/2.0.0/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/corrently.io/2.0.0/openapi.yaml
Tools (28)
Extracted live via the executor SDK.
-
easee.easeeSessionsRefer to easee.cloud API for details.
-
greenPowerIndexGrNstromIndex.gsiBesthourSimple 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 a device should be turned on or off. (Switch state).
-
greenPowerIndexGrNstromIndex.gsiDispatchDispatch 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 index (GrünstromIndex) we have received a tool to automate distribution of energy in order to prevent redispatch situations. Doing this alows to opimize resource usage (tactical) and leverage data for investment planning (strategic).
-
greenPowerIndexGrNstromIndex.gsiMarketdataCompatible to awattar () API interface but data comes from GreenPowerIndex instead of EPEXSpot.
-
greenPowerIndexGrNstromIndex.gsiPredictionRetrieval the GreenPowerIndex (GrünstromIndex) for a given city (by zipcode) in Germany.
-
meteringDecorator.meteringGetRetrieves a metered reading using account (Stromkonto).
-
meteringDecorator.meteringPostPost 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 send updates to get readings (consumption) split into green power (1.8.1) and grey power (1.8.2).
-
ocpp.ocppSessionsReturns lastSession info of OCCP Cloud service for clearing in corrently ecosystem. Might be tested via . Last session Info of managed EV charging stations connected to the correnty ecosystem.
-
openMeter.omActivitiesProvides a list of available meterrs in the OpenMETER project ( ) which grants access for analytics as data discovery.
-
openMeter.omMetersProvides a list of available meterrs in the OpenMETER project ( ) which grants access for analytics as data discovery.
-
openMeter.omReadingsProvides a list of available meterrs in the OpenMETER project ( ) which grants access for analytics as data discovery.
-
stromkontoLedger.prepareTransactionPrepares 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 transaction and enques it for signing and countersigning. This is done from within the user UI using validation process. Note: This API method does not validate any transations. In other words authentication, authorization, validation and actual transfer of value is done using a smart contract during processing in the energy blockchain.
-
stromkontoLedger.stromkontoBalancesStromkonto 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 . Beside of some decoration and reformating operations all data is backed by the to provide consensus of balances and transactions. Use this API Endppoint if you prefere not to work with low level Distributed Ledger Technology (Blockchain).
-
stromkontoLedger.stromkontoChoicesSignable choices (contract changes) for customer.
-
stromkontoLedger.stromkontoLoginSends 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 shared key is used to sign transactions onbehalf of a particular account. However viewing consensus information (balances) are public and might move from account to account without prior notification. Best practice for third party uses is to always start a session with the login RESP call and only create a user in case the response indicates an
unregisteredstatus. -
stromkontoLedger.stromkontoRegisterCalling this method with an unregistered (new) email will create a new account (Stromkonto) with all balances having a value of
0and no transaction history. In addition some basic properties like region and zipcode are set to allow further operation of account. -
stromQuittung.quittungComitUses collected fields or provided fields to create a final receipt (Strom-Quittung).
-
stromQuittung.quittungCreateCreates 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 services.
-
stromQuittung.quittungPrepareDuring 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 in following requests, the existing collection will be extended/updated with the provided body parameters/values.
-
stromQuittung.quittungTseAllows to retrieve all relevant data assiciated to a TSE service call. E.q. Input parameters, public key and signature.
-
stromQuittung.quittungTseDataAllows to retrieve input string for a signing process.
-
stromQuittung.quittungTsEsignatureAllows to retrieve digital signature for a given receipt.
-
stromQuittung.quittungZugferdAllows to retrieve XML of the zugferd invoice.
-
tariffPriceApi.tariffcomponentsProvides insides into the different cost components of energy for a private household. Sample Request:
-
tariffPriceApi.tariffSlpH0Provides pricing data for private households with standard load profiles (Standardlastprofil H0).
-
wiMWechselprozesseImMesswesenStromStatusApi.wimstatusAccess to status information of an existing metering change and allocation process.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools