You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*ASNLookupAPI* | [**getAsnDetails**](docs/ASNLookupAPI.md#getasndetails) | **GET** /asn | Get details of any ASN number or associated IP address
131
+
*AbuseContactAPI* | [**getAbuseContactInfo**](docs/AbuseContactAPI.md#getabusecontactinfo) | **GET** /abuse | Retrieve abuse reporting contact information for a given IP address
132
+
*AstronomyAPI* | [**getAstronomy**](docs/AstronomyAPI.md#getastronomydetails) | **GET** /astronomy | Get sunrise, sunset, moonrise, moonset, and related data for a location
133
+
*IPGeolocationAPI* | [**getBulkIPGeolocation**](docs/IPGeolocationAPI.md#getbulkipgeolocation) | **POST** /ipgeo-bulk | Get geolocation data for multiple IP addresses in a single API request
134
+
*IPGeolocationAPI* | [**getIPGeolocation**](docs/IPGeolocationAPI.md#getipgeolocation) | **GET** /ipgeo | Get geolocation data for a single IP address
*IPSecurityAPI* | [**getIPSecurity**](docs/IPSecurityAPI.md#getipsecurity) | **GET** /security | Retrieve security information (VPN, TOR, proxy, etc.) for a single IP
137
+
*TimeConversionAPI* | [**convertTimezone**](docs/TimezoneConversionAPI.md#converttimezone) | **GET** /timezone/convert | Convert time between two specified timezones
138
+
*TimezoneAPI* | [**getTimezone**](docs/TimezoneAPI.md#gettimezone) | **GET** /timezone | Timezone information details
139
+
*UserAgentAPI* | [**getUserAgent**](docs/Api/UserAgentAPI.md#getuseragentdetails) | **GET** /user-agent | Get details of user-agent
@@ -151,7 +171,7 @@ For complete details, refer to the official documentation: [IP Geolocation API D
151
171
152
172
The `ip` parameter in the SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the `ip()` method is not used or the parameter is omitted, the API will return information about the public IP address of the device or server where the SDK is executed.
153
173
154
-
### 1. Basic Plan Examples
174
+
### 1. Developer (Free) Plan Examples
155
175
156
176
#### Default Fields
157
177
@@ -403,10 +423,10 @@ class GeolocationResponse {
403
423
}
404
424
}
405
425
userAgent: class UserAgentData {
406
-
userAgentString: OpenAPI-Generator/1.0.0/java
407
-
name: OpenAPI-Generator
426
+
userAgentString: IPGeolocation/2.0.0/java
427
+
name: IPGeolocation Java SDK
408
428
type: Special
409
-
version: 1.0.0
429
+
version: 2.0.0
410
430
versionMajor: 1
411
431
device: class UserAgentDataDevice {
412
432
name: Unknown
@@ -696,10 +716,10 @@ class SecurityAPIResponse {
696
716
}
697
717
}
698
718
userAgent: class UserAgentData {
699
-
userAgentString: OpenAPI-Generator/1.0.0/java
700
-
name: OpenAPI-Generator
719
+
userAgentString: IPGeolocation/2.0.0/java
720
+
name: IPGeolocation Java SDK
701
721
type: Special
702
-
version: 1.0.0
722
+
version: 2.0.0
703
723
versionMajor: 1
704
724
device: class UserAgentDataDevice {
705
725
name: Unknown
@@ -1400,10 +1420,10 @@ For more details, refer to official documentation: [Timezone Converter API](http
1400
1420
### Convert Current Time from One Timezone to Another
This section demonstrates how to use the `getAbuseContactInfo()` method of the AbuseContact API. This API helps security teams, hosting providers, and compliance professionals quickly identify the correct abuse reporting contacts for any IPv4 or IPv6 address. You can retrieve data like the responsible organization, role, contact emails, phone numbers, and address to take appropriate mitigation action against abusive or malicious activity.
1767
+
> **Note**: Abuse Contact API is only available in Advanced Plan
1768
+
1769
+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
ASN API provides comprehensive details for an ASN including the as name, organization name, the country of registration, associated domain, and its type (ISP, host provider, or business). The API also shows the allocation date of provided ASN and if it is currently allocated or not. It also contains the routing information including peering, upstreams, and downstreams to help understand the relationship between different ASNs. Example Use Cases: - Looking up ASN information for an IP address (e.g., `GET /asn?ip=8.8.8.8`) - Retrieving ASN information for a specific ASN number (e.g., `GET /asn?asn=12345`) - Getting peering relationships for an ASN (e.g., `GET /asn?asn=12345&include=peers`)
String include ="peers"; // String | This parameter can have four options: a) peers b) downstreams c) upstreams d) routes e) whois_response. You may add any of them in comma-separated way. In order to get the ASN details with peering data, pass peers string in the include parameter like mentioned below.
45
-
String excludes ="asn.date_allocated,asn.allocation_status"; // String | You can exclude fields from the response according to you requirement with the exception of ip field. For example, you want to remove date_allocated and allocation_status from api response, you can put the keys in excludes parameter like this.
46
-
String fields ="asn.organization,asn.country,asn.downstreams"; // String | You can filter out only those fields which you want to see in the response by using the fields parameter. To retrieve only the AS organization, its country and downstreams in api response, you can put the keys in fields parameter like this. API will combine these fields with the default ASN response. Note: Parameters `peers, downstreams, upstreams, routes, whois_response` can be used in both `include` , and `fields`. If you use include and fields at the same time, fields parameter will be considered only.
47
-
try {
48
-
ASNResponse result = apiInstance.getAsnDetails()
49
-
.ip(ip)
50
-
.asn(asn)
51
-
.include(include)
52
-
.excludes(excludes)
53
-
.fields(fields)
54
-
.execute();
55
-
System.out.println(result);
56
-
} catch (ApiException e) {
57
-
System.err.println("Exception when calling AsnLookupApi#asnGet");
ASN API provides comprehensive details for an ASN including the as name, organization name, the country of registration, associated domain, and its type (ISP, host provider, or business). The API also shows the allocation date of provided ASN and if it is currently allocated or not. It also contains the routing information including peering, upstreams, and downstreams to help understand the relationship between different ASNs. Example Use Cases: - Looking up ASN information for an IP address (e.g., `GET /asn?ip=8.8.8.8`) - Retrieving ASN information for a specific ASN number (e.g., `GET /asn?asn=12345`) - Getting peering relationships for an ASN (e.g., `GET /asn?asn=12345&include=peers`)
The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing. In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action.
|**excludes**|**String**| You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this. |[optional]|
24
+
|**fields**|**String**| You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below. |[optional]|
25
+
26
+
### Return type
27
+
28
+
[**AbuseResponse**](AbuseResponse.md)
29
+
30
+
### Authorization
31
+
32
+
[ApiKeyAuth](../README.md#authentication-setup)
33
+
34
+
### HTTP request headers
35
+
36
+
-**Content-Type**: Not defined
37
+
-**Accept**: application/json, application/xml
38
+
39
+
### HTTP response details
40
+
| Status code | Description | Response headers |
41
+
|-------------|-------------|------------------|
42
+
|**200**| Successful response | - |
43
+
|**400**| Bad Request – Possible reasons include: - If the provided IPv4, IPv6 address, or ASN is invalid. - If special character(s) ( ) [] { } | ^ ` is passed in the API URL either as paramter or its value. Specially in case of API key. | - |
44
+
|**401**| Unauthorized – Possible reasons include: - Missing or invalid API key - Account unverified, locked, or disabled - Accessing API with an unauthorized key - Subscription expired or downgraded - If your account has been disabled or locked to use by the admin due to abuse or illegal activity. - When the request to IP Abuse Contact API is made using API key for a database subscription - When the request to IP Abuse Contact API is made on the 'paused' subscription. - If you’re making API requests after your subscription trial has been expired. - If your active until date has passed and you need to upgrade your account. | - |
45
+
|**404**| Not Found – Possible reasons include: - If the IPv4, IPv6, or ASN name does not exist in our database. - If the IPv4, IPv6, or ASN is passed as a path variable, instead of url parameter as ip=. - If the wrong endpoint is called, that does not exist in our API. | - |
46
+
|**405**| Method Not Allowed – Only GET is allowed for `/abuse` endpoint | - |
47
+
|**429**| Too Many Requests – Possible reasons include: - If the API usage limit has reached for the free subscriptions, or paid subscriptions with the status 'past due', 'deleted' or 'trial expired'. - If the surcharge API usage limit has reached against the subscribed plan. | - |
0 commit comments