Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 4.49 KB

README.md

File metadata and controls

84 lines (67 loc) · 4.49 KB

Contributors Forks Stargazers Issues MIT License LinkedIn Twitter GitHub

OpenWeatherMap API Wrapper Library (C#)

Overview

The most complete and modern library written for the OpenWeather API in .Net. This library retrieves the JSON from the OpenWeatherMap API and serializes them into objects. All of the free textual APIs are supported. We have planned support for the paid and mapping APIs, also. See the roadmap for more information.

Clients

  • AirPollutionClient - Current and historical pollution conditions. See OpenWeather API Doc for more information.
  • CurrentWeatherClient - Current weather conditions. See OpenWeather API Doc for more information.
  • FiveDayForecastClient - Up to five days of three-hour forecasts. See OpenWeather API Doc for more information.
  • GeocodingClient - Full support for geocoding by location name, post/zip code, and reverse geocoding. See OpenWeather API Doc for more information.

Installing

Install the NuGet package https://www.nuget.org/packages/CoderPro.OpenWeatherMap.Wrapper/

.NET CLI

dotnet add package CoderPro.OpenWeatherMap.Wrapper

Package Manager

Install-Package CoderPro.OpenWeatherMap.Wrapper

Example Usage

var openWeatherClient = new CoderPro.OpenWeatherMap.Wrapper.CurrentWeatherClient("my open weather API key");

// Use async version wherever possible.
var query = await openWeatherAPI.QueryAsync("city/location");

// or non-async version if needed for legacy code
var query = openWeatherAPI.Query("city/location");

Console.WriteLine($"The temperature in {query.Name}, {query.Sys.Country} is currently {query.Main.Temperature.FahrenheitCurrent} °F");

Demo Applications

A demo .Net 6 Windows Presentation Framework (WPF) application is bundled in this repo. View here

Roadmap

Feature Version Release Date
All free textual APIs 0.5.0 2023/06/08
Demo WPF App 1.0.0 2023/06/17
Weather Triggers API 1.1.0 2023/07/08
One Call API 3 2.0.0 2023/08/08
Weather Maps 1.0 API 2.1.0 2023/09/08
Weather station API 2.2.0 2023/10/08

Change Log

  • 2023/06/17
    • Initial commit