Skip to content

Commit 6322039

Browse files
authored
replaced documentation links to new ones (#12)
1 parent 38adcea commit 6322039

File tree

1 file changed

+24
-134
lines changed

1 file changed

+24
-134
lines changed

README.md

Lines changed: 24 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Based on:
2727
- [Using NPM](#using-npm)
2828
- [Using Yarn](#using-yarn)
2929
- [Manual Installation](#manual-installation)
30-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
30+
3. [API Documentation Links](#api-documentations)
3131
4. [API Endpoints](#api-endpoints)
3232
5. [Fields and Methods Availability](#fields-and-methods-availability)
3333
6. [Authentication Setup](#authentication-setup)
@@ -104,14 +104,17 @@ To include the SDK manually:
104104
yarn install
105105
```
106106

107-
## API Plan Tiers and Documentation
107+
## API Documentations
108108

109-
The documentation below corresponds to the four available API tier plans:
110-
111-
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
112-
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
113-
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
114-
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
109+
The documentation below corresponds to the available APIs:
110+
- [**Overview**](https://ipgeolocation.io/documentation.html)
111+
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
112+
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
113+
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
114+
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
115+
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
116+
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
117+
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)
115118

116119
For a detailed comparison of what each plan offers, visit the [Pricing Page](https://ipgeolocation.io/pricing.html).
117120

@@ -153,7 +156,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
153156
| *UserAgentAPI* | [**parseBulkUserAgentStrings**](https://github.com/IPGeolocation/ip-geolocation-api-typescript-sdk/blob/HEAD/docs/UserAgentApi.md#parsebulkuseragentstrings) |||||
154157

155158
> [!TIP]
156-
> 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).
157160
158161
## Authentication Setup
159162
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
198201
- `dma`
199202
- `time_zone`
200203

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).
202205

203206
### Developer (Free) Plan Examples
204207
#### Get Default Fields
@@ -662,7 +665,7 @@ getBulkLocation();
662665
## IP Security Examples
663666
The `getIpSecurityInfo()` method lets you query threat intelligence, proxy/VPN detection, and risk metadata for IPs.
664667

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).
666669

667670
### Get Security API Default Fields
668671
```typescript
@@ -724,123 +727,10 @@ async function getSecurity() {
724727

725728
getSecurity();
726729
```
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",
752-
"country_capital": "Washington, D.C.",
753-
"state_prov": "Texas",
754-
"state_code": "US-TX",
755-
"district": "Dallas",
756-
"city": "Dallas",
757-
"zipcode": "75201",
758-
"latitude": "32.77822",
759-
"longitude": "-96.79512",
760-
"is_eu": false,
761-
"country_flag": "https://ipgeolocation.io/static/flags/us_64.png",
762-
"geoname_id": "4684902",
763-
"country_emoji": "🇺🇸"
764-
},
765-
"network": {
766-
"asn": {
767-
"as_number": "AS62240",
768-
"organization": "Clouvider Limited",
769-
"country": "GB"
770-
},
771-
"company": {
772-
"name": "Packethub S.A."
773-
}
774-
},
775-
"time_zone": {
776-
"name": "America/Chicago",
777-
"offset": -6,
778-
"offset_with_dst": -5,
779-
"current_time": "2025-07-16 11:00:50.605-0500",
780-
"current_time_unix": 1752681650.605,
781-
"is_dst": true,
782-
"dst_savings": 1,
783-
"dst_exists": true,
784-
"dst_start": {
785-
"utc_time": "2025-03-09 TIME 08",
786-
"duration": "+1H",
787-
"gap": true,
788-
"date_time_after": "2025-03-09 TIME 03",
789-
"date_time_before": "2025-03-09 TIME 02",
790-
"overlap": false
791-
},
792-
"dst_end": {
793-
"utc_time": "2025-11-02 TIME 07",
794-
"duration": "-1H",
795-
"gap": false,
796-
"date_time_after": "2025-11-02 TIME 01",
797-
"date_time_before": "2025-11-02 TIME 02",
798-
"overlap": true
799-
}
800-
},
801-
"user_agent": {
802-
"user_agent_string": "Ipgeolocation/2.0/typescript",
803-
"name": "Ipgeolocation",
804-
"type": "Special",
805-
"version": "2.0",
806-
"version_major": "2",
807-
"device": {
808-
"name": "Unknown",
809-
"type": "Unknown",
810-
"brand": "Unknown",
811-
"cpu": "Unknown"
812-
},
813-
"engine": {
814-
"name": "Unknown",
815-
"type": "Unknown",
816-
"version": "??",
817-
"version_major": "??"
818-
},
819-
"operating_system": {
820-
"name": "Unknown",
821-
"type": "Unknown",
822-
"version": "??",
823-
"version_major": "??",
824-
"build": "??"
825-
}
826-
},
827-
"country_metadata": {
828-
"calling_code": "+1",
829-
"tld": ".us",
830-
"languages": [
831-
"en-US",
832-
"es-US",
833-
"haw",
834-
"fr"
835-
]
836-
},
837-
"currency": {
838-
"code": "USD",
839-
"name": "US Dollar",
840-
"symbol": "$"
841-
}
842-
}
843-
```
730+
731+
> [!NOTE]
732+
> You can get all the available fields in Paid plan in combination with security data, when subscribed to Paid plan.
733+
844734
### Request with Field Filtering
845735
```typescript
846736
async function getSecurity() {
@@ -889,7 +779,7 @@ This section provides usage examples of the `getAsnInfo()` method from the SDK.
889779
> [!NOTE]
890780
> ASN API is only available in the Advanced subscription plans.
891781
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.
893783
### Get ASN Information by IP Address
894784
```typescript
895785
import {
@@ -1055,7 +945,7 @@ You can retrieve data like the responsible organization, role, contact emails, p
1055945
> [!NOTE]
1056946
> Abuse Contact API is only available in the **Advanced Plan**.
1057947
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.
1059949

1060950
### Lookup Abuse Contact by IP
1061951
```typescript
@@ -1164,7 +1054,7 @@ Sample Response:
11641054
## Timezone API Examples
11651055
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.
11661056

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).
11681058

11691059
### Get Timezone by IP Address
11701060

@@ -1564,7 +1454,7 @@ Sample Response:
15641454
## Timezone Converter API Examples
15651455
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.
15661456

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).
15681458

15691459
### Convert Current Time from One Timezone to Another
15701460
```typescript
@@ -1613,7 +1503,7 @@ Simply provide the appropriate source and target parameters in the method.
16131503

16141504
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.
16151505

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).
16171507

16181508
### Parse a Basic User Agent String
16191509

@@ -1696,7 +1586,7 @@ getUserAgentDetails();
16961586
## Astronomy API Examples
16971587
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**.
16981588

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.
17001590

17011591
### Lookup Astronomy API by Coordinates
17021592
```typescript

0 commit comments

Comments
 (0)