N3rgy.Api.Cli 0.1.0

dotnet tool install --global N3rgy.Api.Cli --version 0.1.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local N3rgy.Api.Cli --version 0.1.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=N3rgy.Api.Cli&version=0.1.0
                    
nuke :add-package N3rgy.Api.Cli --version 0.1.0
                    

.NET CLI client for retrieving n3rgy consumer data.

Installation

Set the N3RGY__APIKEY environment variable to your In Home Display (IHD) MAC address (without hyphens). This acts as the security key for the n3rgy API, e.g.

set N3RGY__APIKEY="0123456789ABCDEF"

CLI

You can retrieve consumption and tariff data using the commands below. Note that you can substitute gas for electricity:

n3rgy electricity consumption --start-date 2024-04-20 --end-date 2024-04-24 --output-file electricity_consumption.csv

or

n3rgy electricity tariff --start-date 2024-04-20 --end-date 2024-04-24 --output-file electricity_tariff.csv

Display inline help:

n3rgy --help
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
0.1.0 220 4/23/2024