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
> The availability of fields in every API endpoint across all API plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response).
159
+
> The availability of fields in every API endpoint across Free and Paid plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response).
157
160
158
161
## Authentication Setup
159
162
To authenticate API requests, you'll need an API key from [ipgeolocation.io](https://ipgeolocation.io).
@@ -198,7 +201,7 @@ This section shows how to use the `getIpGeolocation()` method from the TypeScrip
198
201
-`dma`
199
202
-`time_zone`
200
203
201
-
For the full list of supported fields/modules, refer to the [IP Geolocation API Docs](https://ipgeolocation.io/ip-location-api.html#documentation-overview).
204
+
For the full list of supported fields/modules, refer to the [IP Geolocation API Docs](https://ipgeolocation.io/documentation/ip-location-api.html).
202
205
203
206
### Developer (Free) Plan Examples
204
207
#### Get Default Fields
@@ -662,7 +665,7 @@ getBulkLocation();
662
665
## IP Security Examples
663
666
The `getIpSecurityInfo()` method lets you query threat intelligence, proxy/VPN detection, and risk metadata for IPs.
664
667
665
-
For full endpoint specifications, refer to the [IP Security API documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
668
+
For full endpoint specifications, refer to the [IP Security API documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
666
669
667
670
### Get Security API Default Fields
668
671
```typescript
@@ -724,123 +727,10 @@ async function getSecurity() {
724
727
725
728
getSecurity();
726
729
```
727
-
Sample Response:
728
-
```json
729
-
{
730
-
"ip": "2.56.188.34",
731
-
"hostname": "2.56.188.34",
732
-
"security": {
733
-
"threat_score": 80,
734
-
"is_tor": false,
735
-
"is_proxy": true,
736
-
"proxy_type": "VPN",
737
-
"proxy_provider": "Nord VPN",
738
-
"is_anonymous": true,
739
-
"is_known_attacker": true,
740
-
"is_spam": false,
741
-
"is_bot": false,
742
-
"is_cloud_provider": true,
743
-
"cloud_provider": "Packethub S.A."
744
-
},
745
-
"location": {
746
-
"continent_code": "NA",
747
-
"continent_name": "North America",
748
-
"country_code2": "US",
749
-
"country_code3": "USA",
750
-
"country_name": "United States",
751
-
"country_name_official": "United States of America",
> You can get all the available fields in Paid plan in combination with security data, when subscribed to Paid plan.
733
+
844
734
### Request with Field Filtering
845
735
```typescript
846
736
asyncfunction getSecurity() {
@@ -889,7 +779,7 @@ This section provides usage examples of the `getAsnInfo()` method from the SDK.
889
779
> [!NOTE]
890
780
> ASN API is only available in the Advanced subscription plans.
891
781
892
-
Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
782
+
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.
893
783
### Get ASN Information by IP Address
894
784
```typescript
895
785
import {
@@ -1055,7 +945,7 @@ You can retrieve data like the responsible organization, role, contact emails, p
1055
945
> [!NOTE]
1056
946
> Abuse Contact API is only available in the **Advanced Plan**.
1057
947
1058
-
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
948
+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
1059
949
1060
950
### Lookup Abuse Contact by IP
1061
951
```typescript
@@ -1164,7 +1054,7 @@ Sample Response:
1164
1054
## Timezone API Examples
1165
1055
This section provides usage examples of the `getTimezoneInfo()` method from the typescript SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, timezone ID, IATA code, ICAO code, or UN/LOCODE.
1166
1056
1167
-
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/timezone-api.html#documentation-overview).
1057
+
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/documentation/timezone-api.html).
1168
1058
1169
1059
### Get Timezone by IP Address
1170
1060
@@ -1564,7 +1454,7 @@ Sample Response:
1564
1454
## Timezone Converter API Examples
1565
1455
This section provides usage examples of the `convertTimeBetweenTimezones()` method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers and optional date/time inputs.
1566
1456
1567
-
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/timezone-api.html#convert-time-bw-time-zones).
1457
+
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/documentation/timezone-api.html#convert-time-between-time-zones).
1568
1458
1569
1459
### Convert Current Time from One Timezone to Another
1570
1460
```typescript
@@ -1613,7 +1503,7 @@ Simply provide the appropriate source and target parameters in the method.
1613
1503
1614
1504
This section provides usage examples of the `getUserAgentDetails()` and `parseBulkUserAgentStrings()` methods from the TypeScript SDK. The **User Agent API** extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.
1615
1505
1616
-
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/user-agent-api.html#documentation-overview).
1506
+
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/documentation/user-agent-api.html).
1617
1507
1618
1508
### Parse a Basic User Agent String
1619
1509
@@ -1696,7 +1586,7 @@ getUserAgentDetails();
1696
1586
## Astronomy API Examples
1697
1587
This section provides usage examples of the `getAstronomyDetails()` method from the SDK, allowing developers to fetch **sun and moon timings** and **position data** based on **coordinates**, **IP**, or **location string**.
1698
1588
1699
-
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/astronomy-api.html#documentation-overview) for more details.
1589
+
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/documentation/astronomy-api.html) for more details.
0 commit comments