JK.IpGeolocation 0.4.1

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package JK.IpGeolocation --version 0.4.1                

                    
                

            
NuGet\Install-Package JK.IpGeolocation -Version 0.4.1
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="JK.IpGeolocation" Version="0.4.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add JK.IpGeolocation --version 0.4.1                

                    
                

            
#r "nuget: JK.IpGeolocation, 0.4.1"
#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 JK.IpGeolocation as a Cake Addin
#addin nuget:?package=JK.IpGeolocation&version=0.4.1

// Install JK.IpGeolocation as a Cake Tool
#tool nuget:?package=JK.IpGeolocation&version=0.4.1

IpGeolocation

CI NuGet Version

IpGeolocation is a simple library that allows you to get geolocation data based on IP address. It uses ipapi.co API to get the data. The library is written in C# and is available as a NuGet package.

Project structure

  • IpGeolocation - IpGeolocation library
  • IpGeolocation.ConsoleApp - console application with example use of the IpGeolocation library
  • IpGeolocation.ConsoleApp.WithoutConfig - console application with example use of the IpGeolocation library without configuration
  • IpGeolocation.Tests - unit tests

Installation

You can install the library via NuGet package manager:

Install-Package JK.IpGeolocation

or .NET CLI:

dotnet add package JK.IpGeolocation

or just copy into the project file to reference the package:

<PackageReference Include="JK.IpGeolocation" Version="0.4.0" />

Usage

To use the library you need to create an instance of the IpGeolocationService class and call the GetGeolocationData method with the IP address as an argument. The method returns an instance of the GeolocationData class with the geolocation data.

// create services
var services = new ServiceCollection();

// add and register
services.UseIpGeolocation(settings: new IpGeolocationSettings { CacheType = CacheType.MemoryAndFile });

// build service provider
var serviceProvider = services.BuildServiceProvider();

// get service and call method to get geolocation
var ipGeolocation = await serviceProvider.GetRequiredService<IIpGeolocationService>().GetIpGeolocationAsync("8.8.8.8");

// print geolocation data 
Console.WriteLine(ipGeolocation.CountryName); // United States

// dispose service provider to release resources
serviceProvider.Dispose();

Configuration

The library allows you to configure the cache type and the cache expiration time. You can do this by creating an instance of the IpGeolocationSettings class and passing it to the UseIpGeolocation method.

services.UseIpGeolocation(settings: services.UseIpGeolocation(settings: new IpGeolocationSettings
    { CacheType = CacheType.MemoryAndFile, CacheExpirationType = CacheExpirationType.Minutes, CacheExpiration = 60 });

Cache types

The library supports two cache types:

  • Memory - cache data in memory
  • MemoryAndFile - cache data in memory and file

Cache expiration types

The library supports two cache expiration types:

  • Seconds - cache expiration time in seconds
  • Minutes - cache expiration time in minutes
  • Hours - cache expiration time in hours
  • Days - cache expiration time in days
  • Never - cache never expires

Cache

More information about the cache can be found in the CacheDrive library.

Usage with configuration file

The library allows you to use configuration files to configure the library. You can do this by adding the configuration section to the appsettings.json file.

{
  "IpGeolocationSettings": {
    "BaseAddress": "https://ipapi.co/",
    "CacheEnabled": true,
    "CacheFolderName": "cache",
    "CacheExpirationType": "Minutes",
    "CacheExpiration": 60,
    "CacheType": "MemoryAndFile",
    "InitializeOnStartup": true,
    "FlushOnExit": true,
    "HashKeySalt": "123s123",
    "ApiKey": ""
  }
}

Then you can use the UseIpGeolocation method to add and register the library with the configuration.

// create services
var services = new ServiceCollection();

// build config
IConfiguration configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .AddJsonFile("appsettings.dev.json", optional: true, reloadOnChange: true)
    .AddEnvironmentVariables()
    .Build();

// add and register services:
services.UseIpGeolocation(configuration);

// build service provider
var serviceProvider = services.BuildServiceProvider();

// get service and call method to get geolocation
var ipGeolocation = await serviceProvider.GetRequiredService<IIpGeolocationService>().GetIpGeolocationAsync("8.8.8.8");

// print geolocation data 
Console.WriteLine(ipGeolocation.CountryName); // United States

// dispose service provider to release resources
serviceProvider.Dispose();

How to use paid version of the ipapi.co API

If you want to use the paid version of the ipapi.co API, you need to provide the API key in the configuration file or in the IpGeolocationSettings class.

{
  "IpGeolocationSettings": {
    "ApiKey": "your_api_key"
  }
}

If you leave the ApiKey property empty or do not provide it, the library will use the free version of the ipapi.co API.

Code Examples

License

The library is available under the MIT license.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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 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. 
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
0.4.2 84 10/28/2024
0.4.1 173 9/26/2024
0.4.0 90 9/25/2024
0.3.4 133 9/6/2024
0.3.3 110 7/16/2024
0.3.2 134 5/10/2024
0.3.1 144 3/16/2024
0.3.0 161 2/27/2024
0.2.0 131 2/12/2024
0.1.1 239 12/16/2023
0.1.0 130 12/16/2023

The issue with error handling from the external API has been resolved.