Corrently

Corrently.io

*Corrently - from italian corrente, which is energy* Introduction The Corrently ecosystem gets maintained by [STROMDAO GmbH](https://www.stromdao.de/) to…

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Corrently - from italian corrente, which is energy

Introduction

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.
Released SKDs for Download

Endpoints 26

Stromkonto (Ledger)

  • GETBalances/stromkonto/balances?account=stringStromkonto represents a core component of the Corrently Ecosystem. It is a ledger for green energy related transactions and gets heavily used by the public…
  • GETSelectable Choices for customer/stromkonto/choices?account=stringSignable choices (contract changes) for customer.
  • POSTLogin (via Mail)/stromkonto/loginSends 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…
  • POSTPrepare Transaction/stromkonto/prepareTransactionPrepares and inques a transaction (transfer) between two accounts (Stromkonten). This might be used to send any balanced entity. Using this endpoint will only…
  • POSTRegister (new Stromkonto)/stromkonto/registerCalling 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.…

GreenPowerIndex (GrünstromIndex)

  • GETGet best hour (with most regional green energy) in a given timeframe./gsi/bestHour?zip=string&key=string&timeframe=0&hours=0Simple Wrapper around the GreenPowerIndex for easy integration into almost any SmartHome system that allows access to a JSON/REST Service This endpoint is…
  • GETDispatch (Green Energy Distribution Schedule)/gsi/dispatch?zip=string&key=stringDispatch of green energy has two aspects to consider: Availability of gerneration facility (depends on weather and installed capacity) Demand of energy Using…
  • GETMarketdata/gsi/marketdata?zip=stringCompatible to awattar (https://api.awattar.de/v1/marketdata) API interface but data comes from GreenPowerIndex instead of EPEXSpot.
  • GETPrediction/gsi/prediction?zip=string&key=stringRetrieval the GreenPowerIndex (GrünstromIndex) for a given city (by zipcode) in Germany.

Metering (Decorator)

  • GETMeter Reading/metering/reading?account=stringRetrieves a metered reading using account (Stromkonto).
  • POSTMeter Reading/metering/readingPost 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…

Tariff (Price API)

  • GETEnergy Tariff price components/tariff/components?zipcode=string&email=string&kwha=0&milliseconds=0&wh=0Provides insides into the different cost components of energy for a private household. Sample Request:…
  • GETEnergy Tariff information/tariff/slph0?zipcode=stringProvides pricing data for private households with standard load profiles (Standardlastprofil H0).

WiM (Wechselprozesse im Messwesen Strom - Status API)

  • GETWiM Proess Informtion/wim/status?vid=stringAccess to status information of an existing metering change and allocation process.

OpenMETER

  • GETPublic shared smart meters installed in Germany and available for subservices and exploration./alternative/openmeter/activitiesProvides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery.
  • GETPublic shared smart meters installed in Germany and available for subservices and exploration./alternative/openmeter/metersProvides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery.
  • GETPublic shared smart meters installed in Germany and available for subservices and exploration./alternative/openmeter/readingsProvides a list of available meterrs in the OpenMETER project ( https://www.openmeter.de/ ) which grants access for analytics as data discovery.

easee

  • GETReturns lastSession info for all easee wallboxes (chargers) given user has access to./alternative/easee/lastSessions?username=string&password=stringRefer to easee.cloud API for details.

OCPP

  • GETLast Session Info/alternative/ocpp/lastSessionsReturns lastSession info of OCCP Cloud service for clearing in corrently ecosystem. Might be tested via OCPP cloud simulator. Last session Info of managed EV…

Strom-Quittung

  • POSTFinishs a collection of data and finalizes receipt. Use this method after collecting all data via quittung/prepare/quittung/commitUses collected fields or provided fields to create a final receipt (Strom-Quittung).
  • POSTCreate a receipt for an energy delivery (only valid in Germany)./quittung/createCreates a full featured receipt (Quittung) for an energy delivery as it appears on a charging session or similar events. Allows to embed receipt generation…
  • POSTAllows to collect data with several requests (or a single) for a receipt./quittung/prepareDuring 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…
  • POSTRetrieve TSE (Technische Sicherheitseinrichtung) Data for a given receipt (Strom-Quittung)./quittung/tse?account=stringAllows to retrieve all relevant data assiciated to a TSE service call. E.q. Input parameters, public key and signature.
  • POSTRetrieve TSE (Technische Sicherheitseinrichtung) raw data only for a given receipt (Strom-Quittung)./quittung/tsedata?account=stringAllows to retrieve input string for a signing process.
  • POSTRetrieve TSE (Technische Sicherheitseinrichtung) Signature only for a given receipt (Strom-Quittung)./quittung/tsesignature?account=stringAllows to retrieve digital signature for a given receipt.
  • GETRetrieve Zugferd XML for a given receipt (Strom-Quittung)./quittung/zugferd?account=stringAllows to retrieve XML of the zugferd invoice.

API details

Base URL
https://api.corrently.io/v2.0
Authentication
None declared in the description
Operations
26 operations on 25 pathsGET 16POST 10
Main resources
Strom-Quittung 7Stromkonto (Ledger) 5GreenPowerIndex (GrünstromIndex) 4TSE 4OpenMETER 3Metering (Decorator) 2Tariff (Price API) 2Dispatch (Green Energy Distribution API) 1OCPP 1SmartHome 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 2.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Corrently.io in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Corrently.io collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Balances” (GET /stromkonto/balances?account=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Corrently.io?

*Corrently - from italian corrente, which is energy* Introduction The Corrently ecosystem gets maintained by [STROMDAO GmbH](https://www.stromdao.de/) to… It is listed under Data & analytics and has 26 endpoints.

Who publishes the Corrently.io?

It is listed from Corrently's public API description (an OpenAPI document), not published by Corrently on Swastik Codes. Anyone who controls corrently.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Corrently.io?

Requests go to https://api.corrently.io/v2.0. Endpoint paths are added to this base URL.

How do I authenticate with the Corrently.io?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Corrently.io have?

26 operations on 25 paths (16 GET, 10 POST). The largest groups are Strom-Quittung, Stromkonto (Ledger), GreenPowerIndex (GrünstromIndex), TSE.

Is forking the Corrently.io free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.