Skip to content

Commit 8ddd6d0

Browse files
mateen993mateen993
committed
refactor: api docs
1 parent b40e595 commit 8ddd6d0

7 files changed

Lines changed: 2 additions & 292 deletions

File tree

‎docs/ASNLookupApi.md‎

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,6 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1111
1212
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`)
1313

14-
### Example
15-
16-
```typescript
17-
import {
18-
ASNLookupApi,
19-
Configuration
20-
} from 'ipgeolocation-sdk-ts';
21-
22-
const configuration = new Configuration();
23-
const apiInstance = new ASNLookupApi(configuration);
24-
25-
let ip: string; //query parameter \'ip\'. (optional) (default to undefined)
26-
let asn: number; //query paramter \'asn\'. (optional) (default to undefined)
27-
let include: 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. (optional) (default to undefined)
28-
let excludes: 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. (optional) (default to undefined)
29-
let fields: 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. (optional) (default to undefined)
30-
31-
const { status, data } = await apiInstance.getAsnInfo(
32-
ip,
33-
asn,
34-
include,
35-
excludes,
36-
fields
37-
);
38-
```
3914

4015
### Parameters
4116

‎docs/AbuseContactApi.md‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,6 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1111
1212
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.
1313

14-
### Example
15-
16-
```typescript
17-
import {
18-
AbuseContactApi,
19-
Configuration
20-
} from 'ipgeolocation-sdk-ts';
21-
22-
const configuration = new Configuration();
23-
const apiInstance = new AbuseContactApi(configuration);
24-
25-
let ip: string; //query parameter \'ip\'. (optional) (default to undefined)
26-
let 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) (default to undefined)
27-
let 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) (default to undefined)
28-
29-
const { status, data } = await apiInstance.getAbuseContactInfo(
30-
ip,
31-
excludes,
32-
fields
33-
);
34-
```
3514

3615
### Parameters
3716

‎docs/AstronomyApi.md‎

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,7 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1111
1212
The Astronomy API provides the location-based rise and set times for the Sun and Moon along with the current position, distance from earth, and azimuth of the Sun and the Moon for a specific date at the queried time.
1313

14-
### Example
15-
16-
```typescript
17-
import {
18-
AstronomyApi,
19-
Configuration
20-
} from 'ipgeolocation-sdk-ts';
21-
22-
const configuration = new Configuration();
23-
const apiInstance = new AstronomyApi(configuration);
24-
25-
let ip: string; //query paramter \'ip\'. If not provided, will be your network IP (optional) (default to undefined)
26-
let location: string; //query paramter \'location\'. If not provided, will be your ip location (optional) (default to undefined)
27-
let lat: string; //query paramter \'lat\'. (optional) (default to undefined)
28-
let _long: string; //query paramter \'long\'. (optional) (default to undefined)
29-
let date: string; //The date (YYYY-MM-DD) to lookup for. default will be the current date (optional) (default to undefined)
30-
let elevation: number; //query parameter \'elevation\' (optional) (default to undefined)
31-
let output: string; //Desired output format. (optional) (default to undefined)
32-
let lang: 'en' | 'de' | 'ru' | 'ja' | 'fr' | 'cn' | 'es' | 'cs' | 'it' | 'ko' | 'fa' | 'pt'; //By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`. (optional) (default to undefined)
33-
34-
const { status, data } = await apiInstance.getAstronomyDetails(
35-
ip,
36-
location,
37-
lat,
38-
_long,
39-
date,
40-
elevation,
41-
output,
42-
lang
43-
);
44-
```
14+
4515

4616
### Parameters
4717

‎docs/IPLocationApi.md‎

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,6 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1212
1313
This feature is available only on our paid API subscriptions (STANDARD or ADVANCED). This endpoint allows you to perform the geolocation lookup for multiple IPv4, IPv6 addresses or domain names (maximum 50,000) at the same time. The requests count per lookup is equal to total IP addresses or domain names passed. To perform bulk IP Geolocation Lookup, send a POST request and pass the \"ips\" array as JSON data along with it.
1414

15-
### Example
16-
17-
```typescript
18-
import {
19-
IPLocationApi,
20-
Configuration,
21-
GetBulkIpGeolocationRequest
22-
} from 'ipgeolocation-sdk-ts';
23-
24-
const configuration = new Configuration();
25-
const apiInstance = new IPLocationApi(configuration);
26-
27-
let getBulkIpGeolocationRequest: GetBulkIpGeolocationRequest; //
28-
let lang: 'en' | 'de' | 'ru' | 'ja' | 'fr' | 'cn' | 'es' | 'cs' | 'it' | 'ko' | 'fa' | 'pt'; //By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`. (optional) (default to undefined)
29-
let fields: string; //you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path. (optional) (default to undefined)
30-
let excludes: string; //you can also filter the API response by excluding specific fields (except the IP address) that you don\'t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path (optional) (default to undefined)
31-
let include: string; //IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn\'t respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn\'t respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`. (optional) (default to undefined)
32-
let output: string; //Desired output format(json or xml). (optional) (default to undefined)
33-
34-
const { status, data } = await apiInstance.getBulkIpGeolocation(
35-
getBulkIpGeolocationRequest,
36-
lang,
37-
fields,
38-
excludes,
39-
include,
40-
output
41-
);
42-
```
4315

4416
### Parameters
4517

‎docs/SecurityApi.md‎

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,7 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1212
1313
The Bulk IP Security Lookup API can provide security details for up to `50,000` bulk IPs. This API also has parameters to customize the response, just like the single IP Security Lookup API.
1414

15-
### Example
16-
17-
```typescript
18-
import {
19-
SecurityApi,
20-
Configuration,
21-
GetBulkIpGeolocationRequest
22-
} from 'ipgeolocation-sdk-ts';
23-
24-
const configuration = new Configuration();
25-
const apiInstance = new SecurityApi(configuration);
26-
27-
let getBulkIpGeolocationRequest: GetBulkIpGeolocationRequest; //
28-
let include: string; //Include optional objects like `location`, `network`. Use comma-separated values. Example: include=location,network (optional) (default to undefined)
29-
let fields: string; //Get specific fields, objects from the response. (optional) (default to undefined)
30-
let excludes: string; //Exclude specific fields, objects from the response. (optional) (default to undefined)
31-
let output: string; //Desired output format. (optional) (default to undefined)
32-
let lang: 'en' | 'de' | 'ru' | 'ja' | 'fr' | 'cn' | 'es' | 'cs' | 'it' | 'ko' | 'fa' | 'pt'; //By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`. (optional) (default to undefined)
33-
34-
const { status, data } = await apiInstance.getBulkIpSecurityInfo(
35-
getBulkIpGeolocationRequest,
36-
include,
37-
fields,
38-
excludes,
39-
output,
40-
lang
41-
);
42-
```
15+
4316

4417
### Parameters
4518

@@ -88,33 +61,6 @@ const { status, data } = await apiInstance.getBulkIpSecurityInfo(
8861
8962
IP Security API provides security details of a given IP. It detects whether the IP is proxy, tor or bot. It also shows the proxy types of the IP (like VPN, PROXY, RELAY etc.) with it\'s VPN/proxy service provider making our API powerful VPN checker. It finds the IPs that are involved in spam activities. It also checks whether the IP links to a cloud provider and includes the provider\'s name.
9063

91-
### Example
92-
93-
```typescript
94-
import {
95-
SecurityApi,
96-
Configuration
97-
} from 'ipgeolocation-sdk-ts';
98-
99-
const configuration = new Configuration();
100-
const apiInstance = new SecurityApi(configuration);
101-
102-
let ip: string; //query parameter \'ip\'. If not provided, will be your network IP (optional) (default to undefined)
103-
let include: string; //Include optional details like location and/or network. (optional) (default to undefined)
104-
let fields: string; //Get specific fields, objects from the response. (optional) (default to undefined)
105-
let excludes: string; //Exclude specific fields, objects from the response. (optional) (default to undefined)
106-
let output: string; //Desired output format (json or xml). (optional) (default to undefined)
107-
let lang: 'en' | 'de' | 'ru' | 'ja' | 'fr' | 'cn' | 'es' | 'cs' | 'it' | 'ko' | 'fa' | 'pt'; //By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`. (optional) (default to undefined)
108-
109-
const { status, data } = await apiInstance.getIpSecurityInfo(
110-
ip,
111-
include,
112-
fields,
113-
excludes,
114-
output,
115-
lang
116-
);
117-
```
11864

11965
### Parameters
12066

‎docs/TimezoneApi.md‎

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,6 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1111
1212
The Time Zone API provides current time, date, and time zone-related information. It supports various input types including time zone name, geographic coordinates, addresses, IPs, and location codes. The API determines the time zone based on the following priority order if multiple parameters are provided: 1. Time Zone Name 2. Geographic Coordinates (latitude & longitude) 3. Location Address 4. IP Address 5. IATA Code 6. ICAO Code 7. UN/LOCODE Enriched response data is returned based on the type of input: - IP: includes geolocation info - Address: includes location metadata - IATA/ICAO: includes airport info - UN/LOCODE: includes city details You can call the time zone API without passing any time zone, coordinates, IATA, ICAO, LO code or IP address as well. It will use the calling machine\'s IP address to return the regional time zone information.
1313

14-
### Example
15-
16-
```typescript
17-
import {
18-
TimezoneApi,
19-
Configuration
20-
} from 'ipgeolocation-sdk-ts';
21-
22-
const configuration = new Configuration();
23-
const apiInstance = new TimezoneApi(configuration);
24-
25-
let tz: string; //pass a valid time zone name as a query parameter tz to get the time zone information. (optional) (default to undefined)
26-
let location: string; //pass any address of a location as the query parameter location to get the time zone information. (optional) (default to undefined)
27-
let lat: number; //pass the latitude of a location as query parameters to get the time zone information. (optional) (default to undefined)
28-
let _long: number; //pass the longitude of a location as query parameters to get the time zone information. (optional) (default to undefined)
29-
let ip: string; //You can pass any IPv4 or IPv6 address as a query parameter ip to get the regional timezone information. (optional) (default to undefined)
30-
let iataCode: string; //pass any 3 letter IATA code as a query paramter iata_code to get the comprehensive airport details along with the time zone information, in which that airport exists. (optional) (default to undefined)
31-
let icaoCode: string; //pass any 4 letter ICAO code as a query paramter icao_code to get the comprehensive airport details along with the time zone information, in which that airport exists. (optional) (default to undefined)
32-
let loCode: string; //pass any 5 letter UNLOCODE as a query paramter lo_code to get the comprehensive lo code/city details along with the time zone information of the concerned city. (optional) (default to undefined)
33-
let output: string; //Desired output format (json or xml). (optional) (default to undefined)
34-
let lang: 'en' | 'de' | 'ru' | 'ja' | 'fr' | 'cn' | 'es' | 'cs' | 'it' | 'ko' | 'fa' | 'pt'; //By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`. (optional) (default to undefined)
35-
36-
const { status, data } = await apiInstance.getTimezoneInfo(
37-
tz,
38-
location,
39-
lat,
40-
_long,
41-
ip,
42-
iataCode,
43-
icaoCode,
44-
loCode,
45-
output,
46-
lang
47-
);
48-
```
4914

5015
### Parameters
5116

‎docs/UserAgentApi.md‎

Lines changed: 0 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,7 @@ All URIs are relative to *https://api.ipgeolocation.io/v2*
1313
1414
User Agent Parser API provides the accurate browser, device, and operating system details from a User Agent String. It also provides information about crawlers and attack sources. You can use these details to customize user experience, prevent crawlers and attackers from accessing your website.
1515

16-
### Example
1716

18-
```typescript
19-
import {
20-
UserAgentApi,
21-
Configuration
22-
} from 'ipgeolocation-sdk-ts';
23-
24-
const configuration = new Configuration();
25-
const apiInstance = new UserAgentApi(configuration);
26-
27-
let userAgent: string; // (optional) (default to undefined)
28-
let output: string; //Desired output format (json or xml). (optional) (default to undefined)
29-
30-
const { status, data } = await apiInstance.getUserAgentDetails(
31-
userAgent,
32-
output
33-
);
34-
```
3517

3618
### Parameters
3719

@@ -73,26 +55,7 @@ const { status, data } = await apiInstance.getUserAgentDetails(
7355
7456
This endpoint allows you to perform the parsing of multiple User-Angent strings (max. 50,000) at the same time. The requests count per round is equal to total User-Agent strings passed. This feature is `only available for paid plans`.
7557

76-
### Example
77-
78-
```typescript
79-
import {
80-
UserAgentApi,
81-
Configuration,
82-
ParseBulkUserAgentStringsRequest
83-
} from 'ipgeolocation-sdk-ts';
84-
85-
const configuration = new Configuration();
86-
const apiInstance = new UserAgentApi(configuration);
87-
88-
let output: string; //Desired output format (json or xml). (optional) (default to undefined)
89-
let parseBulkUserAgentStringsRequest: ParseBulkUserAgentStringsRequest; // (optional)
9058

91-
const { status, data } = await apiInstance.parseBulkUserAgentStrings(
92-
output,
93-
parseBulkUserAgentStringsRequest
94-
);
95-
```
9659

9760
### Parameters
9861

@@ -129,64 +92,4 @@ const { status, data } = await apiInstance.parseBulkUserAgentStrings(
12992

13093
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
13194

132-
# **parseUserAgentString**
133-
> UserAgentData parseUserAgentString()
134-
135-
You can also provide custom User-Agent string to parse in JSON payload. This endpoint is meant to be called from server-side and is available for paid subscriptions only.
136-
137-
### Example
138-
139-
```typescript
140-
import {
141-
UserAgentApi,
142-
Configuration,
143-
ParseUserAgentStringRequest
144-
} from 'ipgeolocation-sdk-ts';
145-
146-
const configuration = new Configuration();
147-
const apiInstance = new UserAgentApi(configuration);
148-
149-
let output: string; //Desired output format (json or xml). (optional) (default to undefined)
150-
let parseUserAgentStringRequest: ParseUserAgentStringRequest; // (optional)
151-
152-
const { status, data } = await apiInstance.parseUserAgentString(
153-
output,
154-
parseUserAgentStringRequest
155-
);
156-
```
157-
158-
### Parameters
159-
160-
|Name | Type | Description | Notes|
161-
|------------- | ------------- | ------------- | -------------|
162-
| **parseUserAgentStringRequest** | **ParseUserAgentStringRequest**| | |
163-
| **output** | [**string**] | Desired output format (json or xml). | (optional) defaults to undefined|
164-
165-
166-
### Return type
167-
168-
**UserAgentData**
169-
170-
### Authorization
171-
172-
[ApiKeyAuth](../README.md#ApiKeyAuth)
173-
174-
### HTTP request headers
175-
176-
- **Content-Type**: application/json
177-
- **Accept**: application/json, application/xml
178-
179-
180-
### HTTP response details
181-
| Status code | Description | Response headers |
182-
|-------------|-------------|------------------|
183-
|**200** | Successful request | - |
184-
|**400** | Bad Request – Possible reasons include: - If the user-agent string is empty/null. | - |
185-
|**401** | Unauthorized – Possible reasons include: - If API key (as apiKey URL parameter) is missing from the request to User Agent API. - If the provided API key is not valid. - If your account has been disabled or locked by admin because of any illegal activity. - If you’re making requests after your subscription trial has been expired. - If you’ve exceeded your requests limit. - If your subscription is paused or is not active. - If you’re accessing a paid feature on free subscription. | - |
186-
|**405** | If wrong HTTP request method is used for calling the endpoints. Only POST Method is acceptable for this endpoint | - |
187-
|**429** | Too Many Requests – API usage limits exceeded for current plan | - |
188-
|**499** | Client Closed Request – Client terminated connection before completion | - |
189-
|**500** | Internal Server Error – Something went wrong on our end | - |
190-
191-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
19295

0 commit comments

Comments
 (0)