WebsiteCarbonAPI-NET 1.0.0

dotnet add package WebsiteCarbonAPI-NET --version 1.0.0                
NuGet\Install-Package WebsiteCarbonAPI-NET -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WebsiteCarbonAPI-NET" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add WebsiteCarbonAPI-NET --version 1.0.0                
#r "nuget: WebsiteCarbonAPI-NET, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install WebsiteCarbonAPI-NET as a Cake Addin
#addin nuget:?package=WebsiteCarbonAPI-NET&version=1.0.0

// Install WebsiteCarbonAPI-NET as a Cake Tool
#tool nuget:?package=WebsiteCarbonAPI-NET&version=1.0.0                

WebsiteCarbon-NET

A C# API wrapper for the website websitecarbon.com. A website that calculates carbon emissions of websites using a rough estimate

Features

  • Get information for websites and number of bytes passed
  • Asynchronous method calls

Credits:

Notes:

  • Getting a result from this API takes a bit of time to calculate the first time. Future calls for the same URL / information within 24 hours will be much faster
  • Exceptions come from Refit in the form of APIException

Example Use:

Getting information from a website

WebsiteCarbonClient client = new WebsiteCarbonClient();
WebsiteCarbon carbon = await client.GetWebsiteInformationAsync("https://github.com/");
Console.WriteLine(carbon.Bytes);
Console.WriteLine(carbon.Green);
Console.WriteLine(carbon.CleanerThan);
Console.WriteLine(carbon.Statistics.CO2.Grid.Grams);
Console.WriteLine(carbon.Statistics.CO2.Renewable.Litres);
Console.WriteLine(carbon.Timestamp);

Getting information from a number of bytes

WebsiteCarbonClient client = new WebsiteCarbonClient();
WebsiteCarbon carbon = await client.GetDataInBytesInformationAsync(100, 1); // 100 is # of bytes, 1 is green status (can be any number, preferably 0 or 1 representing False and True respectively)
Console.WriteLine(carbon.CleanerThan);
Console.WriteLine(carbon.Statistics.AdjustedBytes);
Console.WriteLine(carbon.Statistics.CO2.Grid.Grams);
Console.WriteLine(carbon.Statistics.CO2.Renewable.Litres);
Console.WriteLine(carbon.Timestamp);
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 428 3/17/2023

Initial release