Overview
Command Line Interface
API Documentation
Java
Official Java client library for the ipdata API. If you have any issues create a new issue here - https://github.com/ipdata/java/issues/new
Table of Contents
Install
You can have the library from Maven Central.
1
<dependency>
2
<groupId>co.ipdata.client</groupId>
3
<artifactId>ipdata-java-client</artifactId>
4
<version>TBD</version>
5
</dependency>
Copied!
Configuration
A builder is available to help configure your client configuration, you'll have to provide the API endpoint and an API key:
1
import io.ipdata.client.Ipdata;
2
3
/.../
4
URL url = new URL("https://api.ipdata.co");
5
IpdataService ipdataService = Ipdata.builder().url(url)
6
.key("MY_KEY").get();
7
/.../
Copied!
Optionally, you can configure a cache for faster access (less than 1ms latency on requests that hit the cache).
The cache is configurable for time and space eviction policies:
1
URL url = new URL("https://api.ipdata.co");
2
IpdataService ipdataService = Ipdata.builder().url(url)
3
.withCache()
4
.timeout(30, TimeUnit.MINUTES) //ttl after first write
5
.maxSize(8 * 1024) //no more than 8*1024 items shall be stored in cache
6
.registerCacheConfig()
7
.key("MY_KEY")
8
.get();
9
IpdataModel model = ipdataService.ipdata("1.1.1.1"); //cache miss here
10
ipdataService.ipdata("1.1.1.1"); //cache hit from now on on ip address "1.1.1.1"
Copied!
API
The client is fully compliant with the API. The data model of the api is available under the package
io.ipdata.client.model. Interaction with the API is captured by the Service Interface io.ipdata.client.service.IpdataService:Basic Usage
To get all available information about a given IP address, you can use the
ipdata method of the service Interface:1
IpdataModel model = ipdataService.ipdata("1.1.1.1");
2
System.out.println(jsonSerialize(model));
Copied!
Output:
1
{
2
"ip": "1.1.1.1",
3
"is_eu": false,
4
"city": null,
5
"region": null,
6
"region_code": null,
7
"country_name": "Australia",
8
"country_code": "AU",
9
"continent_name": "Oceania",
10
"continent_code": "OC",
11
"latitude": -33.494,
12
"longitude": 143.2104,
13
"postal": null,
14
"calling_code": "61",
15
"flag": "https://ipdata.co/flags/au.png",
16
"emoji_flag": "\ud83c\udde6\ud83c\uddfa",
17
"emoji_unicode": "U+1F1E6 U+1F1FA",
18
"asn": {
19
"asn": "AS13335",
20
"name": "Cloudflare, Inc.",
21
"domain": "cloudflare.com",
22
"route": "1.1.1.0/24",
23
"type": "hosting"
24
},
25
"languages": [
26
{
27
"name": "English",
28
"native": "English"
29
}
30
],
31
"currency": {
32
"name": "Australian Dollar",
33
"code": "AUD",
34
"symbol": "AUquot;,
35
"native": "quot;,
36
"plural": "Australian dollars"
37
},
38
"time_zone": {
39
"name": "Australia/Sydney",
40
"abbr": "AEDT",
41
"offset": "+1100",
42
"is_dst": true,
43
"current_time": "2020-01-29T20:22:52.283874+11:00"
44
},
45
"threat": {
46
"is_tor": false,
47
"is_proxy": false,
48
"is_anonymous": false,
49
"is_known_attacker": false,
50
"is_known_abuser": false,
51
"is_threat": false,
52
"is_bogon": false
53
},
54
"count": "0"
55
}
Copied!
Single Field Selection
If you're interested in only one field from the model capturing an IP address information, The service interface exposes a method on each available field:
1
boolean isEu = ipdataService.isEu("1.1.1.1");
2
AsnModel asn = ipdataService.asn("1.1.1.1");
3
TimeZone tz = ipdataService.timeZone("1.1.1.1");
4
ThreatModel threat = ipdataService.threat("1.1.1.1");
5
/*...*/
Copied!
Multiple Field Selection
If you're interested by multiple fields for a given IP address, you'll use the
getFields method:1
import io.ipdata.client.service.IpdataField;
2
import io.ipdata.client.service.IpdataService;
3
4
/* The model will be hydrated by the selected fields only */
5
IpdataModel model = ipdataService.getFields("1.1.1.1", IpdataField.ASN, IpdataField.CURRENCY);
Copied!
Bulk data
You can as well get multiple responses at once by using the
bulk api:1
List<IpdataModel> models = ipdataService.bulk(Arrays.asList("1.1.1.1", "8.8.8.8"));
Copied!
Last modified 1yr ago
Copy link