Package io.ipdata.client.service

Interface IpdataService

public interface IpdataService

Primary interface for accessing the ipdata.co API.

Provides methods for looking up geolocation, threat intelligence, and other metadata for IP addresses. Supports single IP lookups, bulk lookups, and selective field retrieval.

Also exposes single-field accessors (e.g. getCountryName, getCity) inherited from IpdataInternalSingleFieldClient.

See Also:

Ipdata.builder()

Method Summary

Modifier and Type	Method	Description
AsnModel	asn(String ip)
List<IpdataModel>	bulk(List<String> ips)	Retrieves IP data for multiple IP addresses in a single request.
Currency	currency(String ip)
String	getCallingCode(String ip)
String	getCity(String ip)
String	getContinentCode(String ip)
String	getCountryCode(String ip)
String	getCountryName(String ip)
String	getEmojiFlag(String ip)
String	getEmojiUnicode(String ip)
IpdataModel	getFields(String ip, IpdataField<?>... fields)	Retrieves only the specified fields for the given IP address.
String	getFlag(String ip)
String	getIp(String ip)
double	getLatitude(String ip)
double	getLongitude(String ip)
String	getOrganisation(String ip)
String	getPostal(String ip)
IpdataModel	ipdata(String ip)	Retrieves the full IP data model for the given IP address.
boolean	isEu(String ip)
ThreatModel	threat(String ip)
TimeZone	timeZone(String ip)

Method Detail

ipdata

IpdataModel ipdata(String ip)
            throws IpdataException

Retrieves the full IP data model for the given IP address.

Parameters:

ip - an IPv4 or IPv6 address

Returns:

the full geolocation and metadata for the IP

Throws:

IpdataException - if the API call fails

bulk

List<IpdataModel> bulk(List<String> ips)
                throws IpdataException

Retrieves IP data for multiple IP addresses in a single request.

Parameters:

ips - list of IPv4 or IPv6 addresses

Returns:

a list of IP data models, one per input address

Throws:

IpdataException - if the API call fails

getFields

IpdataModel getFields(String ip,
                      IpdataField<?>... fields)
               throws IpdataException

Retrieves only the specified fields for the given IP address.

Fields are sorted before querying to maximize cache hit rates when caching is enabled.

Parameters:

ip - an IPv4 or IPv6 address

fields - one or more fields to retrieve (e.g. IpdataField.ASN, IpdataField.CURRENCY)

Returns:

a partial IP data model containing only the requested fields

Throws:

IpdataException - if the API call fails

IllegalArgumentException - if no fields are specified

getIp

String getIp(String ip)
      throws IpdataException

Throws:

IpdataException

isEu

boolean isEu(String ip)
      throws IpdataException

Throws:

IpdataException

getCity

String getCity(String ip)
        throws IpdataException

Throws:

IpdataException

getCountryName

String getCountryName(String ip)
               throws IpdataException

Throws:

IpdataException

getCountryCode

String getCountryCode(String ip)
               throws IpdataException

Throws:

IpdataException

getContinentCode

String getContinentCode(String ip)
                 throws IpdataException

Throws:

IpdataException

getLongitude

double getLongitude(String ip)
             throws IpdataException

Throws:

IpdataException

getLatitude

double getLatitude(String ip)
            throws IpdataException

Throws:

IpdataException

getOrganisation

String getOrganisation(String ip)
                throws IpdataException

Throws:

IpdataException

getPostal

String getPostal(String ip)
          throws IpdataException

Throws:

IpdataException

getCallingCode

String getCallingCode(String ip)
               throws IpdataException

Throws:

IpdataException

getFlag

String getFlag(String ip)
        throws IpdataException

Throws:

IpdataException

getEmojiFlag

String getEmojiFlag(String ip)
             throws IpdataException

Throws:

IpdataException

getEmojiUnicode

String getEmojiUnicode(String ip)
                throws IpdataException

Throws:

IpdataException

asn

AsnModel asn(String ip)
      throws IpdataException

Throws:

IpdataException

timeZone

TimeZone timeZone(String ip)
           throws IpdataException

Throws:

IpdataException

currency

Currency currency(String ip)
           throws IpdataException

Throws:

IpdataException

threat

ThreatModel threat(String ip)
            throws IpdataException

Throws:

IpdataException