https://github.com/tsjdev-apps/openweathermap-sharp
A .NET client wrapper for https://openweathermap.org written in .NET Standard 2.0
https://github.com/tsjdev-apps/openweathermap-sharp
Last synced: 5 months ago
JSON representation
A .NET client wrapper for https://openweathermap.org written in .NET Standard 2.0
- Host: GitHub
- URL: https://github.com/tsjdev-apps/openweathermap-sharp
- Owner: tsjdev-apps
- License: mit
- Created: 2023-09-29T17:12:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-29T20:31:09.000Z (7 months ago)
- Last Synced: 2025-12-02T01:38:46.761Z (7 months ago)
- Language: C#
- Size: 196 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenWeatherMapSharp
A .NET client wrapper for [https://openweathermap.org](https://openweathermap.org) written in .NET Standard 2.0
## Installation
Install the package via [NuGet](https://www.nuget.org/packages/OpenWeatherMapSharp).
[](https://www.nuget.org/packages/OpenWeatherMapSharp)
## Usage
First you need to get a free API key from [openweathermap.org](https://www.openweathermap.org). You can create a new account and you will find your API keys [here](https://home.openweathermap.org/api_keys).
You need to create a new instance of `OpenWeatherMapService` passing in the *API key*. There is also an interface available, if you are using Dependency Injection.
```csharp
///
/// Gets forecast data for a location based
/// on its geographic coordinates.
///
Task> GetForecastAsync(
double latitude,
double longitude,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets forecast data based on a city ID.
///
[Obsolete]
Task> GetForecastAsync(
int cityId,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets forecast data based on a city name.
///
[Obsolete]
Task> GetForecastAsync(
string city,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets current weather data for a location based on its geographic coordinates.
///
Task> GetWeatherAsync(
double latitude,
double longitude,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets current weather data based on a city ID.
///
[Obsolete]
Task> GetWeatherAsync(
int cityId,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets current weather data based on a city name.
///
[Obsolete]
Task> GetWeatherAsync(
string city,
LanguageCode language = LanguageCode.EN,
Unit unit = Unit.Standard);
///
/// Gets a list of matching locations for a given query string.
///
Task>> GetLocationByNameAsync(
string query,
int limit = 5);
///
/// Gets geolocation information based on a ZIP or postal code.
///
Task> GetLocationByZipAsync(
string zipCode);
///
/// Gets a list of matching locations for a given pair of coordinates.
///
Task>> GetLocationByLatLonAsync(
double latitude,
double longitude,
int limit = 5);
///
/// Retrieves current air pollution data for a specific location.
///
Task> GetAirPollutionAsync(
double latitude,
double longitude);
///
/// Retrieves forecasted air pollution data for the coming days for a specific location.
///
Task> GetAirPollutionForecastAsync(
double latitude,
double longitude);
///
/// Retrieves historical air pollution data for a specific location and time range.
///
Task> GetAirPollutionHistoryAsync(
double latitude,
double longitude,
DateTime start,
DateTime end);
```
***HINT:*** Some methods are marked as `obsolete`, because [openweathermap.org](https://openweathermap.org) marked these methods as depracted. Currently they are all still working, but might be removed in feature releases. They recommend using the methods with *latitude* and *longitude* to get the current weather or the forecast.
## Sample
Here is a screenshot of the `Console Application` using the [NuGet package](https://www.nuget.org/packages/OpenWeatherMapSharp) to get the current weather for a provided city.
## Buy Me A Coffee
I appreciate any form of support to keep my *Open Source* activities going.
Whatever you decide, be it reading and sharing my blog posts, using my NuGet packages or buying me a coffee/book, thank you ❤️.
[](https://www.buymeacoffee.com/tsjdevapps)
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)