CkJava Requires Chilkat v11.0.0+
CkJava
Look up an IP address with the ip-api free endpoint
See more Geolocation Examples
This example uses the free, keyless ip-api endpoint for non-commercial use. The free service supports HTTP and is limited to 45 requests per minute per source IP. Its Pro service provides HTTPS and commercial use. ip-api Pro.
Always include status and message when selecting fields. Invalid or private addresses can produce status=fail inside a JSON response. Retain the X-Rl and X-Ttl response values between calls, and pause further requests when X-Rl reaches zero.
IP geolocation estimates a network location. VPNs, mobile gateways, and anycast routing can affect the result. City and coordinate fields can be missing or approximate. The sample address 8.8.8.8 is a public DNS address used to demonstrate the request.
Chilkat CkJava Downloads
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
boolean success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
// Use a public IP address. Provider results can change as their databases are updated.
String ipAddress = "8.8.8.8";
CkHttp http = new CkHttp();
http.put_RequireSslCertVerify(true);
http.put_ConnectTimeout(10);
http.put_ReadTimeout(30);
http.put_Accept("application/json");
// The free endpoint is HTTP-only. This single lookup sends no API credentials.
CkStringBuilder url = new CkStringBuilder();
url.Append("http://ip-api.com/json/");
url.Append(http.urlEncode(ipAddress));
CkJsonObject parameters = new CkJsonObject();
parameters.UpdateString("fields","status,message,query,country,countryCode,regionName,city,lat,lon,timezone");
CkHttpResponse response = new CkHttpResponse();
success = http.HttpParams("GET",url.getAsString(),parameters,response);
if (response.get_StatusCode() == 0) {
// Request diagnostics can contain an API key. Report transport failure without logging credentials.
System.out.println("No HTTP response. Check connectivity, DNS, and TLS configuration.");
return;
}
// Save these values if the application will make further requests.
String remaining = response.getHeaderField("X-Rl");
if (remaining == "0") {
System.out.println("Rate limit reached. Wait " + response.getHeaderField("X-Ttl") + " seconds before the next request.");
}
CkJsonObject json = new CkJsonObject();
boolean parsed = json.Load(response.bodyStr());
if ((success != true) || (response.get_StatusCode() < 200) || (response.get_StatusCode() >= 300)) {
System.out.println("Lookup failed. HTTP " + response.get_StatusCode());
if (parsed == true) {
if (json.JsonTypeOf("message") == 1) {
System.out.println(json.stringOf("message"));
}
}
return;
}
if (parsed != true) {
System.out.println("Expected a JSON object in the lookup response.");
return;
}
if (json.StringOfEquals("status","success",true) != true) {
System.out.println("The service could not complete the lookup.");
if (json.JsonTypeOf("message") == 1) {
System.out.println(json.stringOf("message"));
}
return;
}
if ((json.JsonTypeOf("query") != 1) || (json.StringOfEquals("query","",true) == true)) {
System.out.println("The response did not contain the expected IP address.");
return;
}
System.out.println("IP address: " + json.stringOf("query"));
if ((json.JsonTypeOf("country") == 1) && (json.StringOfEquals("country","",true) != true)) {
System.out.println("Country: " + json.stringOf("country"));
}
else {
System.out.println("Country: unavailable");
}
if ((json.JsonTypeOf("countryCode") == 1) && (json.StringOfEquals("countryCode","",true) != true)) {
System.out.println("Country code: " + json.stringOf("countryCode"));
}
else {
System.out.println("Country code: unavailable");
}
if ((json.JsonTypeOf("regionName") == 1) && (json.StringOfEquals("regionName","",true) != true)) {
System.out.println("Region: " + json.stringOf("regionName"));
}
else {
System.out.println("Region: unavailable");
}
if ((json.JsonTypeOf("city") == 1) && (json.StringOfEquals("city","",true) != true)) {
System.out.println("City: " + json.stringOf("city"));
}
else {
System.out.println("City: unavailable");
}
if ((json.JsonTypeOf("timezone") == 1) && (json.StringOfEquals("timezone","",true) != true)) {
System.out.println("Time zone: " + json.stringOf("timezone"));
}
else {
System.out.println("Time zone: unavailable");
}
// Missing coordinates stay unavailable. A numeric zero is a valid coordinate.
if ((json.JsonTypeOf("lat") == 2) && (json.JsonTypeOf("lon") == 2)) {
System.out.println("Coordinates: " + json.stringOf("lat") + ", " + json.stringOf("lon"));
}
else {
System.out.println("Coordinates: unavailable");
}
}
}