IP Geolocation API .NET SDK
Overview
The official .NET Library (C# SDK) for IPGeolocation.io's set of APIs, provides a quick, developer friendly, way to access IP Location, Security, Timezone, Astronomy, ASN, Abuse Contact, and useragent data. Lookup your own IP or provide any IPv4, IPv6 or domain name to get structured results in C#, without the need for manual handling HTTP clients, serialization, or authentication.
- IP Location API: Get all-in-one unified solution for location (city, locality, state, country, etc.), currency, network (AS number, ASN name, organization, asn type, date of allocation, company/ISP name, company type, company domain), timezone , useragent string parsing, security (threat score, is_tor, is_bot, proxy_provider, cloud_provider), and abuse contact (route/CIDR network, country, address, email, phone numbers) information.
- IP Security API: Get security, network, location, hostname, timezone and useragent parsing.
- ASN API: Get ASN details along with peers, upstreams, downstreams, routes, and raw WHOIS.
- Abuse Contact API: Get abuse emails, phone numbers, kind, organization, route/CIDR network and country.
- Astronomy API: Get sunrise, sunset, moonrise, moonset, moon phases with precise twilight period times in combination with location information.
- Timezone API: Get timezone name, multiple time formats, daylight saving status and its details along with location information.
- Timezone Convert API: Convert time between timezone names, geo coordinates, location addresses, IATA codes, ICAO codes, or UN/LOCODE.
- User Agent API: Get browser, Operating System, and device info from single or multiple Useragent string parsing.
This library aims to empower developers to integrate threat intelligence, personalization, fraud prevention, compliance, and analytics features directly into .NET applications. Whether you're enriching signup forms with ip geolocation data, localizing content, embedding threat intelligence, or converting time zones for distributed systems, the library provides a high-performance, scalable implementation leveraging .NET's modern HTTP stack and async programming model.
Based on:
- API version: 2.0
Official Release:
- Available on NuGet Gallery
- Source Code: GitHub Repository
Requirements
- ✅ .NET 6.0+
- ✅ .NET 7.0
- ✅ .NET 8.0
- ✅ .NET Standard 2.1
- API Key from IPGeolocation.io
❌ Not compatible with .NET Framework (which only supports .NET Standard 2.0)
Installation
1.Using .NET CLI
2.Using NuGet Package Manager
3.Using Paket CLI
API Plan Tiers and Documentation
The documentation below corresponds to the four available API tier plans:
- Developer Plan (Free): Full Documentation
- Standard Plan: Full Documentation
- Advance Plan: Full Documentation
- Security Plan: Full Documentation
For a detailed comparison of what each plan offers, visit the Pricing Page.
API Endpoints
All URIs are relative to https://api.ipgeolocation.io/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| IPGeolocationApi | getIpGeolocation | GET /ipgeo | Get geolocation data for a single IP address |
| IPGeolocationApi | getBulkIpGeolocation | POST /ipgeo-bulk | Get geolocation data for multiple IP addresses |
| IPSecurityApi | getIpSecurityInfo | GET /security | Get threat intelligence for a single IP address |
| IPSecurityApi | getBulkIpSecurityInfo | POST /security-bulk | Get threat intelligence for multiple IP addresses |
| ASNLookupApi | getAsnInfo | GET /asn | Get details of any ASN number |
| AbuseContactApi | getAbuseContactInfo | GET /abuse | Retrieve abuse contact data for an IP address |
| AstronomyApi | getAstronomyDetails | GET /astronomy | Get sun and moon timings and positions |
| TimezoneApi | getTimezoneInfo | GET /timezone | Get timezone information based on IP, coordinates, or name |
| TimeConversionApi | convertTimeBetweenTimezones | GET /timezone/convert | Convert time from one timezone to another |
| UserAgentApi | getUserAgentDetails | GET /user-agent | Parse a single user-agent string |
| UserAgentApi | parseUserAgentString | POST /user-agent | Alternate method to parse a single user-agent string |
| UserAgentApi | parseBulkUserAgentStrings | POST /user-agent-bulk | Parse multiple user-agent strings |
Fields and Methods Availability
IP Geolocation offers four plans from billing point of view: Free, Standard, Security, Advance. The availability of each method calling from the respective class, over all plans are presented below.
| Class | Method | Free | Standard | Security | Advance |
|---|---|---|---|---|---|
| IPGeolocationApi | getIpGeolocation |  | |  | |
| IPGeolocationApi | getBulkIpGeolocation | | | | |
| IPSecurityApi | getIpSecurityInfo | | | | |
| IPSecurityApi | getBulkIpSecurityInfo | | | | |
| ASNLookupApi | getAsnInfo | | | | |
| AbuseContactApi | getAbuseContactInfo | | | | |
| AstronomyApi | getAstronomyDetails | | | | |
| TimezoneApi | getTimezoneInfo | | | | |
| TimeConversionApi | convertTimeBetweenTimezones | | | | |
| UserAgentApi | getUserAgentDetails | | | | |
| UserAgentApi | parseUserAgentString | | | | |
| UserAgentApi | parseBulkUserAgentStrings | | | | |
The availability of fields in every API endpoint across all API plans is provided in the Reference Table within each respective API Documentation. e.g., for IPGeolocationApi, please visit https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response.
Authentication Setup
You’ll need an API key from ipgeolocation.io.
1.How to Get Your API Key
- Sign up here: https://app.ipgeolocation.io/signup
- (optional) Verify your email, if you signed up using email.
- Log in to your account: https://app.ipgeolocation.io/login
- After logging in, navigate to your Dashboard to find your API key: https://app.ipgeolocation.io/dashboard
2.ApiKeyAuth
Once you've obtained the api key, authenticate globally via dependency injection:
IP Geolocation Examples
This section demonstrates usage of the GetIpGeolocationAsync method from the SDK across Free, Standard, and Advanced subscription tiers. You can customize the request using parameters like fields , include , and excludes .
Parameters
-
fields: Use this parameter to include specific fields in the response. -
excludes: Use this parameter to omit specific fields from the response. -
include: Use this parameter to add optional modules to the response, such as:-
security -
user_agent -
hostname -
liveHostname -
hostnameFallbackLive -
abuse -
dma -
time_zone
-
For full API details, refer to the IP Geolocation API Documentation
The ip parameter in the SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the ip parameter is omitted, the API will return information about the public IP address of the device or server where the SDK is executed.
1.Developer (Free) Plan Examples
a.Get Default Fields
Sample Response:
Filtering Specific Fields from the Response (Use of 'exclude' and 'fields').
Sample Response:
2.Standard Plan Examples
a.Get Default Fields
Sample Response:
b.Retrieving Geolocation Data in Multiple Languages
Here is an example to get the geolocation data for IP address '2001:4230:4890::1' in French language(fr):
Sample Response:
c.Include Hostname, Timezone, and User-Agent
Sample Response:
The IP Geolocation API supports hostname lookup for all paid subscriptions. However, this is not included by default. To enable hostname resolution, use the include parameter with one of the following options:
-
hostname: Performs a quick lookup using the internal hostname database. If no match is found, the IP is returned as-is. This is fast but may produce incomplete results. -
liveHostname: Queries live sources for accurate hostname resolution. This may increase response time. -
hostnameFallbackLive: Attempts the internal database first, and falls back to live sources if no result is found. This option provides a balance of speed and reliability.
3.Advanced Plan Example
a.Include DMA, Abuse, and Security Modules
Sample Response:
These examples demonstrate typical usage of the IP Geolocation API with different subscription tiers. Use fields to specify exactly which data to receive, include for optional data like security and user agent, and excludes to omit specific keys from the response.
All features available in the Free plan are also included in the Standard and Advanced plans. Similarly, all features of the Standard plan are available in the Advanced plan.
4.Bulk IP Geolocation Example
The SDK also supports bulk IP geolocation using GetBulkIpGeolocationAsync() . All parameters like fields , include , and excludes are supported.
IP Security Examples
This section demonstrates how to use the IP Security API provided by the SDK. These examples show different ways to query threat intelligence and risk metadata for IP addresses using optional parameters like fields , include , and excludes .
For detailed API specs, refer to the IP Security API documentation.
1.Get Default Security Info
Sample Response:
2.Include Multiple Optional Fields
This example shows how to include additional modules like location, network, currency, time_zone, etc., to enrich the response with more context.
You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.
3.Request with Field Filtering
Sample Response:
4.Bulk IP Security Request
The SDK supports sending a list of IPs in a single bulk call using GetBulkIpSecurityInfoAsync() with support for fields and include.
ASN API Examples
This section demonstrates how to use the GetAsnInfoAsync() method from the .NET SDK to retrieve Autonomous System Number (ASN) information.
ASN API is only available on the Advanced subscription plans.
For more details on supported fields and their usage, refer to the ASN API documentation.
1.Get ASN Information by IP Address
Sample Response:
2.Get ASN Information by ASN Number
Sample Response:
3.Combine All Objects Using include
Sample Response:
Abuse Contact API Examples
This section demonstrates how to use the GetAbuseContactInfoAsync() method of the Abuse Contact API. This API helps security teams, hosting providers, and compliance professionals quickly identify the correct abuse reporting contacts for any IPv4 or IPv6 address. You can retrieve data like the responsible organization, role, contact emails, phone numbers, and address to take appropriate mitigation action against abusive or malicious activity.
Abuse Contact API is only available in Advanced Plan.
Refer to the official Abuse Contact API documentation for details on all available fields.
1.Lookup Abuse Contact by IP
Sample Response:
2.Lookup Abuse Contact with Specific Fields
Sample Response:
3.Lookup Abuse Contact while Excluding Fields
Sample Response:
Timezone API Examples
This section demonstrates how to use the GetTimezoneInfoAsync() method from the .NET SDK to retrieve time zone and current time information for various input types.
You can query using various types of inputs: Time Zone name, Latitude/Longitude, Address, IP, IATA/ICAO/UN LOCODE, or even no input (defaults to caller's IP).
For full API specifications, refer to the Timezone API documentation.
1.Get Timezone by IP Address
Sample Response:
The Time Zone API is available to all users. However, multi-language support is only available for paid users.
2.Get Timezone by Timezone Name
Sample Response:
3.Get Timezone from Any Address
Sample Response:
4.Get Timezone from Location Coordinates
Sample Response:
5.Get Timezone and Airport Details from IATA Code
Sample Response:
Similarly, you can fetch Airport Details and Timezone using any ICAO code as well.
6.Get Timezone and City Details from UN/LOCODE
Sample Response:
Timezone Converter API Examples
This section provides usage examples of the ConvertTimeBetweenTimezonesAsync() method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers, coordinates, or location codes.
For full API reference, see the Timezone Converter API Documentation.
1.Convert Current Time from One Timezone to Another
Sample Response:
You can convert time from any timezone to another using:
- Coordinate (latitude & longitude)
- Locations (city or address)
- IATA codes
- ICAO codes
- UN/LOCODE
Simply provide the appropriate source and target parameters in the method.
User Agent API Examples
This section provides usage examples of the GetUserAgentDetailsAsync() and GetBulkUserAgentAsync methods from the .NET SDK. The User Agent API extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.
For complete details, see the User Agent API documentation.
1.Parse a Basic User Agent String
Sample Response:
If you don't pass any userAgent, the API returns data based on the device's user agent.
2.Bulk User Agent Parsing Example
The SDK also supports bulk parsing using the ParseBulkUserAgentStringsAsync() method. You can parse multiple user agent strings in a single request.
Astronomy API Examples
This section provides usage examples of the GetAstronomyDetailsAsync() method from the SDK, allowing developers to fetch sun and moon timings and position data based on coordinates, IP, or location string.
Refer to the official Astronomy API documentation for more details.
1.Lookup Astronomy Info by Coordinates
Sample Response:
2.Lookup Astronomy API by IP Address
Sample Response:
3.Lookup Astronomy API by Location String
Sample Response:
4.Lookup Astronomy API for Specific Date
Sample Response:
5.Lookup Location Info in Different Language
You can also get Astronomy data in other languages as well. Only paid subscriptions can access this feature.
Sample Response:
Models
- ASNConnection
- ASNResponse
- ASNResponseAsn
- Abuse
- AbuseResponse
- AstronomyEvening
- AstronomyLocation
- AstronomyMorning
- Astronomy
- AstronomyResponse
- CountryMetadata
- Currency
- ErrorResponse
- GeolocationResponse
- BulkIPGeolocationResponse
- BulkIPGeolocationResponse1
- BulkIPRequest
- BulkIPSecurityResponse
- BulkIPSecurityResponse1
- Location
- LocationMinimal
- Network
- NetworkAsn
- NetworkCompany
- NetworkMinimal
- NetworkMinimalAsn
- NetworkMinimalCompany
- BulkUserAgentRequest
- UserAgentRequest
- Security
- SecurityAPIResponse
- TimeConversionResponse
- TimeZoneDetailedResponse
- TimeZoneDstEnd
- TimeZoneDstStart
- TimezoneAirport
- TimezoneDetail
- TimezoneDetailDstEnd
- TimezoneDetailDstStart
- TimezoneLocation
- TimezoneLocode
- UserAgentData
- UserAgentDataDevice
- UserAgentDataEngine
- UserAgentDataOperatingSystem
