https://github.com/ipinfo/java
Official Java library for IPinfo API (IP geolocation and other types of IP data)
https://github.com/ipinfo/java
api ip-address ip-data ip-geolocation ipinfo java
Last synced: 3 months ago
JSON representation
Official Java library for IPinfo API (IP geolocation and other types of IP data)
- Host: GitHub
- URL: https://github.com/ipinfo/java
- Owner: ipinfo
- License: apache-2.0
- Created: 2018-06-24T08:22:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-23T03:29:05.000Z (6 months ago)
- Last Synced: 2025-09-29T13:49:56.709Z (3 months ago)
- Topics: api, ip-address, ip-data, ip-geolocation, ipinfo, java
- Language: Java
- Homepage: https://ipinfo.io
- Size: 356 KB
- Stars: 124
- Watchers: 21
- Forks: 50
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - IPinfo
README
# [
](https://ipinfo.io/) IPinfo Java Client Library
[](LICENSE)
This is the official Java client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:
- [IP geolocation data](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude, and longitude)
- [ASN information](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
- [Company data](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address)
- [Carrier details](https://ipinfo.io/ip-carrier-api) (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
Check all the data we have for your IP address [here](https://ipinfo.io/what-is-my-ip).
### Getting Started
You'll need an IPinfo API access token, which you can get by signing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup).
The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing)
[Click here to view the Java SDK's API documentation](https://ipinfo.github.io/java/).
The library also supports the Lite API, see the [Lite API section](#lite-api) for more info.
#### Installation
##### Maven
Add these values to your pom.xml file:
Dependency:
```xml
io.ipinfo
ipinfo-api
3.1.0
compile
```
#### Quick Start
##### IP Information
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out the hostname
System.out.println(response.getHostname());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
##### ASN Information
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
ASNResponse response = ipInfo.lookupASN("AS7922");
// Print out country name
System.out.println(response.getCountry());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Errors
- `ErrorResponseException`: A runtime exception accessible through the
`ExecutionException` of a future. This exception signals that something went
wrong when mapping the API response to the wrapper. You probably can't
recover from this exception.
- `RateLimitedException` An exception signaling that you've been rate limited.
##### Lite API
The library gives the possibility to use the [Lite API](https://ipinfo.io/developers/lite-api) too, authentication with your token is still required.
The returned details are slightly different from the Core API.
```java
import io.ipinfo.api.IPinfoLite;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponseLite;
public class Main {
public static void main(String... args) {
IPinfoLite ipInfoLite = new IPinfoLite.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponseLite response = ipInfoLite.lookupIP("8.8.8.8");
// Print out the ASN
System.out.println(response.getAsn()); // AS15169
// Print out the country code
System.out.println(response.getCountryCode()); // US
// Print out the country name
System.out.println(response.getCountry()); // United States
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Caching
This library provides a very simple caching system accessible in `SimpleCache`.
Simple cache is an in-memory caching system that resets every time you restart
your code.
If you prefer a different caching methodology, you may use the `Cache`
interface and implement your own caching system around your own infrastructure.
The default cache length is 1 day, this can be changed by calling the
SimpleCache constructor yourself.
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
// 5 Day Cache
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.setCache(new SimpleCache(Duration.ofDays(5)))
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out the hostname
System.out.println(response.getHostname());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Country Name Lookup
This library provides a system to lookup country names through ISO2 country
codes.
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out the country code
System.out.println(response.getCountryCode());
// Print out the country name
System.out.println(response.getCountryName());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### EU Country Lookup
This library provides a system to lookup if a country is a member of the European Union (EU) through
ISO2 country codes.
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out whether the country is a member of the EU
System.out.println(response.isEU());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Internationalization
This library provides a system to lookup if a country is a member of the European Union (EU), emoji and unicode of the country's flag, code and symbol of the country's currency, and public link to the country's flag image as an SVG and continent code and name through ISO2 country codes.
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out whether the country is a member of the EU
System.out.println(response.isEU());
// CountryFlag{emoji='🇺🇸',unicode='U+1F1FA U+1F1F8'}
System.out.println(response.getCountryFlag());
// https://cdn.ipinfo.io/static/images/countries-flags/US.svg
System.out.println(response.getCountryFlagURL());
// CountryCurrency{code='USD',symbol='$'}
System.out.println(response.getCountryCurrency());
// Continent{code='NA',name='North America'}
System.out.println(response.getContinent());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Location Information
This library provides an easy way to get the latitude and longitude of an IP Address:
```java
import io.ipinfo.api.IPinfo;
import io.ipinfo.api.errors.RateLimitedException;
import io.ipinfo.api.model.IPResponse;
public class Main {
public static void main(String... args) {
IPinfo ipInfo = new IPinfo.Builder()
.setToken("YOUR TOKEN")
.build();
try {
IPResponse response = ipInfo.lookupIP("8.8.8.8");
// Print out the Latitude and Longitude
System.out.println(response.getLatitude());
System.out.println(response.getLongitude());
} catch (RateLimitedException ex) {
// Handle rate limits here.
}
}
}
```
#### Extra Information
- This library is thread-safe. Feel free to call the different endpoints from
different threads.
- This library uses Square's http client. Please refer to their documentation
to get information on more functionality you can use.
### Other Libraries
There are official [IPinfo client libraries](https://ipinfo.io/developers/libraries) available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. There are also many third-party libraries and integrations available for our API.
### About IPinfo
Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.
[](https://ipinfo.io/)