Official Java client library for IPinfo
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
util
.travis.yml
LICENSE
README.md
pom.xml

README.md

IPinfo IPinfo Java Client Library

License Travis

This is the official Java client library for the IPinfo.io IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:

  • IP geolocation (city, region, country, postal code, latitude and longitude)
  • ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
  • Company details (the name and domain of the business that uses the IP address)
  • Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

Getting Started

You'll need an IPinfo API access token, which you can get by singing up for a free account at https://ipinfo.io/signup.

The free plan is limited to 1,000 requests a day, 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

Installation

Maven

Add these values to your pom.xml file:

Dependency:

<dependencies>
    <dependency>
        <groupId>io.ipinfo</groupId>
        <artifactId>ipinfo-api</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

Quick Start

IP Information
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 = 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
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 = 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 signalling that you've been rate limited.

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.

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 = 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.

By default, this translation exists for English (United States). If you wish to provide a different language mapping, just use the following system in the builder:

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 = IPInfo.builder().setToken("YOUR TOKEN").setCountryFile(new File("path/to/file.json")).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.
        }
    }
}

This file must follow the same layout as seen here

More language files can be found here

Location Information

This library provides an easy way to get the latitude and longitude of an IP Address:

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 = IPInfo.builder().setToken("YOUR TOKEN").setCountryFile(new File("path/to/file.json")).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 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.

https://ipinfo.io/developers/libraries

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 and IP type data sets. Our API handles over 12 billion requests a month for 100,000 businesses and developers.

image