# corrently_io > Corrently___from_italian_corrente_which_is_energy_IntroductionThe_Corrently_ecosystem_gets_maintained_by__STROMDAO_GmbH_https__www_stromdao_de__to_support_green_energy_services_for_prosumers_grid_operators_regulators_integrators_or_any_other_party_with_an Latest version **2.0.0** (published 2021-06-06) · Apache 2.0 license · 0 weekly downloads ## Install ```sh npm install corrently_io pnpm add corrently_io yarn add corrently_io bun add corrently_io ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.0 | | Published | 2021-06-06 | | First published | 2021-06-06 | | Weekly downloads | 0 | | License | Apache 2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 172.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | stromdao | ## Links - npm: https://www.npmjs.com/package/corrently_io - Homepage: https://corrently.io/ - npm.io page: https://npm.io/package/corrently_io ## Dependencies (2) - [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0 - [superagent](https://npm.io/package/superagent.md) ^5.3.0 ## Recent versions - 2.0.0 (latest) — 2021-06-06 ## README # corrently_io CorrentlyIo - JavaScript client for corrently_io *Corrently - from italian corrente, which is energy* # Introduction The Corrently ecosystem gets maintained by [STROMDAO GmbH](https://www.stromdao.de/) 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](https://www.corrently.de/) got first launched in Germany parts of this documentation provide simple translations for better understanding. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 2.0.0 - Package version: 2.0.0 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit [https://stromdao.de/kontakt](https://stromdao.de/kontakt) ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install corrently_io --save ``` Finally, you need to build the module: ```shell npm run build ``` ##### Local development To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` To use the link you just defined in your project, switch to the directory you want to use your corrently_io from, and run: ```shell npm link /path/to/ ``` Finally, you need to build the module: ```shell npm run build ``` #### git If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ### Webpack Configuration Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var CorrentlyIo = require('corrently_io'); var api = new CorrentlyIo.DispatchGreenEnergyDistributionAPIApi() var opts = { 'zip': "zip_example", // {String} Zipcode (Postleitzahl) of a city in Germany. 'key': "key_example" // {String} Any valid Stromkonto account (address). }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.gsiDispatch(opts, callback); ``` ## Documentation for API Endpoints All URIs are relative to *https://api.corrently.io/v2.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *CorrentlyIo.DispatchGreenEnergyDistributionAPIApi* | [**gsiDispatch**](docs/DispatchGreenEnergyDistributionAPIApi.md#gsiDispatch) | **GET** /gsi/dispatch | Dispatch (Green Energy Distribution Schedule) *CorrentlyIo.GreenPowerIndexGrnstromIndexApi* | [**gsiBesthour**](docs/GreenPowerIndexGrnstromIndexApi.md#gsiBesthour) | **GET** /gsi/bestHour | Get best hour (with most regional green energy) in a given timeframe. *CorrentlyIo.GreenPowerIndexGrnstromIndexApi* | [**gsiDispatch**](docs/GreenPowerIndexGrnstromIndexApi.md#gsiDispatch) | **GET** /gsi/dispatch | Dispatch (Green Energy Distribution Schedule) *CorrentlyIo.GreenPowerIndexGrnstromIndexApi* | [**gsiMarketdata**](docs/GreenPowerIndexGrnstromIndexApi.md#gsiMarketdata) | **GET** /gsi/marketdata | Marketdata *CorrentlyIo.GreenPowerIndexGrnstromIndexApi* | [**gsiPrediction**](docs/GreenPowerIndexGrnstromIndexApi.md#gsiPrediction) | **GET** /gsi/prediction | Prediction *CorrentlyIo.MeteringDecoratorApi* | [**meteringGet**](docs/MeteringDecoratorApi.md#meteringGet) | **GET** /metering/reading | Meter Reading *CorrentlyIo.MeteringDecoratorApi* | [**meteringPost**](docs/MeteringDecoratorApi.md#meteringPost) | **POST** /metering/reading | Meter Reading *CorrentlyIo.OpenMETERApi* | [**omActivities**](docs/OpenMETERApi.md#omActivities) | **GET** /alternative/openmeter/activities | Public shared smart meters installed in Germany and available for subservices and exploration. *CorrentlyIo.OpenMETERApi* | [**omMeters**](docs/OpenMETERApi.md#omMeters) | **GET** /alternative/openmeter/meters | Public shared smart meters installed in Germany and available for subservices and exploration. *CorrentlyIo.OpenMETERApi* | [**omReadings**](docs/OpenMETERApi.md#omReadings) | **GET** /alternative/openmeter/readings | Public shared smart meters installed in Germany and available for subservices and exploration. *CorrentlyIo.SmartHomeApi* | [**gsiBesthour**](docs/SmartHomeApi.md#gsiBesthour) | **GET** /gsi/bestHour | Get best hour (with most regional green energy) in a given timeframe. *CorrentlyIo.StromkontoLedgerApi* | [**prepareTransaction**](docs/StromkontoLedgerApi.md#prepareTransaction) | **POST** /stromkonto/prepareTransaction | Prepare Transaction *CorrentlyIo.StromkontoLedgerApi* | [**stromkontoBalances**](docs/StromkontoLedgerApi.md#stromkontoBalances) | **GET** /stromkonto/balances | Balances *CorrentlyIo.StromkontoLedgerApi* | [**stromkontoChoices**](docs/StromkontoLedgerApi.md#stromkontoChoices) | **GET** /stromkonto/choices | Selectable Choices for customer *CorrentlyIo.StromkontoLedgerApi* | [**stromkontoLogin**](docs/StromkontoLedgerApi.md#stromkontoLogin) | **POST** /stromkonto/login | Login (via Mail) *CorrentlyIo.StromkontoLedgerApi* | [**stromkontoRegister**](docs/StromkontoLedgerApi.md#stromkontoRegister) | **POST** /stromkonto/register | Register (new Stromkonto) *CorrentlyIo.TariffPriceAPIApi* | [**tariffSLPH0**](docs/TariffPriceAPIApi.md#tariffSLPH0) | **GET** /tariff/slph0 | Energy Tariff information *CorrentlyIo.TariffPriceAPIApi* | [**tariffcomponents**](docs/TariffPriceAPIApi.md#tariffcomponents) | **GET** /tariff/components | Energy Tariff price components *CorrentlyIo.WiMWechselprozesseImMesswesenStromStatusAPIApi* | [**wimstatus**](docs/WiMWechselprozesseImMesswesenStromStatusAPIApi.md#wimstatus) | **GET** /wim/status | WiM Proess Informtion ## Documentation for Models - [CorrentlyIo.Balance](docs/Balance.md) - [CorrentlyIo.Componentsh0](docs/Componentsh0.md) - [CorrentlyIo.DispatchLocation](docs/DispatchLocation.md) - [CorrentlyIo.ForecastItem](docs/ForecastItem.md) - [CorrentlyIo.InlineObject](docs/InlineObject.md) - [CorrentlyIo.InlineObject1](docs/InlineObject1.md) - [CorrentlyIo.InlineObject2](docs/InlineObject2.md) - [CorrentlyIo.InlineObject3](docs/InlineObject3.md) - [CorrentlyIo.InlineResponse200](docs/InlineResponse200.md) - [CorrentlyIo.InlineResponse2001](docs/InlineResponse2001.md) - [CorrentlyIo.InlineResponse2001Location](docs/InlineResponse2001Location.md) - [CorrentlyIo.InlineResponse2001Matrix](docs/InlineResponse2001Matrix.md) - [CorrentlyIo.InlineResponse2001MatrixH0](docs/InlineResponse2001MatrixH0.md) - [CorrentlyIo.InlineResponse2002](docs/InlineResponse2002.md) - [CorrentlyIo.InlineResponse2002Timeframe](docs/InlineResponse2002Timeframe.md) - [CorrentlyIo.InlineResponse2003](docs/InlineResponse2003.md) - [CorrentlyIo.InlineResponse2004](docs/InlineResponse2004.md) - [CorrentlyIo.InlineResponse2005](docs/InlineResponse2005.md) - [CorrentlyIo.InlineResponse2006](docs/InlineResponse2006.md) - [CorrentlyIo.MarketData](docs/MarketData.md) - [CorrentlyIo.Ommeters](docs/Ommeters.md) - [CorrentlyIo.Tariffh0](docs/Tariffh0.md) - [CorrentlyIo.Transactions](docs/Transactions.md) ## Documentation for Authorization All endpoints do not require authorization. --- _Source: https://npm.io/package/corrently_io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._