| Name |
Function |
Description |
Type |
| getRaw |
result.getRaw() |
Get the raw JSON string response from our API. This can be useful for debugging, providing feedback, and long-term storage. |
String |
| getMessage |
result.getMessage() |
Get the response message string for this request. This usually returns "Success" but can include administrator-level information on why a request failed. |
String |
| getSuccess |
result.getSuccess() |
A boolean containing the request's success or failure status. True on success, false on failure. |
Boolean |
| getRequestID |
result.getRequestID() |
The unique ID associated with this request. Helpful for debugging and postbacks. |
String |
| getFraudScore |
result.getFraudScore() |
Number 0 - 100 describing how likely this device is to commit fraud. 0 being not at all, 100 being definitively fraudulent. We suggest blocking users greater than 85. |
Float |
| getCountryCode |
result.getCountryCode() |
A two-character country code based on this user's IP address. |
String |
| getRegion |
result.getRegion() |
A string describing the region this user's IP is from. |
String |
| getCity |
result.getCity() |
A string describing the city this user's IP is from. |
String |
| getISP |
result.getISP() |
A string describing the ISP this user's IP belongs to. |
String |
| getOrganization |
result.getOrganization() |
A string describing the Organization to which this user's IP belongs. |
String |
| getASN |
result.getASN() |
The ASN assigned to the ISP to which this user's IP belongs. |
Integer |
| getLatitude |
result.getLatitude() |
The latitude where this user's IP is located. |
Float |
| getLongitude |
result.getLongitude() |
The longitude where this user's IP is located. |
Float |
| getIsCrawler |
result.getIsCrawler() |
Returns true if this user's IP is from any of the following search engine crawlers: Baidu, Google, Bing, Yahoo, Yandex, Sogou, Exabot, DuckDuckGo, Facebook, Twitter, Pinterest, Naver, UptimeRobot, AppleBot, ArchiveBot, CoccocBot, YisouBot, PetalBot, ByteDance, and MailRU. |
Boolean |
| getTimezone |
result.getTimezone() |
Returns the timezone this user's IP is from. |
String |
| getHost |
result.getHost() |
Returns the hostname of this user's IP address. |
String |
| getIsProxy |
result.getIsProxy() |
Returns true if this user's IP is a known proxy. |
Boolean |
| getIsVPN |
result.getIsVPN() |
Returns true if this user's IP is a known VPN. |
Boolean |
| getIsTOR |
result.getIsTOR() |
Returns true if this user's IP is a known or suspected TOR node. |
Boolean |
| getRecentAbuse |
result.getRecentAbuse() |
Returns true if this user's IP has been reported for being abusive recently or if this device has been seen performing abusive actions. |
Boolean |
| getBotStatus |
result.getBotStatus() |
Returns true if this user's IP has been reported for botting or if this device has been seen performing bot-like actions. |
Boolean |
| getConnectionType |
result.getConnectionType() |
Classification of the IP address connection type as "Residential", "Corporate", "Education", "Mobile", or "Data Center". |
String |
| getDeviceSuspicious |
result.getDeviceSuspicious() |
Returns true if this device has suspicious properties or has been seen performing suspicious activities recently. |
Boolean |
| getDeviceEmulated |
result.getDeviceEmulated() |
Returns true if this device has been emulated or appears to have been emulated. |
Boolean |
| getDeviceID |
result.getDeviceID() |
A unique identifier for this device. |
String |