Skip to content

Commit 8ffb79a

Browse files
Merge pull request #16 from IPGeolocation/feature/readme-update
replaced documentation links to new ones
2 parents dae4693 + a561359 commit 8ffb79a

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Based on:
2828
- [Using NPM](#using-npm)
2929
- [Using Yarn](#using-yarn)
3030
- [Manual Installation](#manual-installation)
31-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
31+
3. [API Documentation Links](#api-documentations)
3232
4. [API Endpoints](#api-endpoints)
3333
5. [Fields and Methods Availability](#fields-and-methods-availability)
3434
6. [Authentication Setup](#authentication-setup)
@@ -106,14 +106,17 @@ or with Yarn:
106106
```bash
107107
yarn install
108108
```
109-
## API Plan Tiers and Documentation
110-
111-
The documentation below corresponds to the four available API tier plans:
112-
113-
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
114-
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
115-
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
116-
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
109+
## API Documentations
110+
111+
The documentation below corresponds to the available APIs:
112+
- [**Overview**](https://ipgeolocation.io/documentation.html)
113+
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
114+
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
115+
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
116+
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
117+
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
118+
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
119+
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)
117120

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

@@ -155,7 +158,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
155158
| *UserAgentAPI* | [**parseUserAgentString**](https://github.com/IPGeolocation/ip-geolocation-api-javascript-sdk/blob/HEAD/docs/UserAgentAPI.md#parseuseragentstring) |||||
156159

157160
> [!TIP]
158-
> 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).
161+
> 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).
159162
160163
## Authentication Setup
161164
To authenticate API requests, you'll need an API key from [ipgeolocation.io](https://ipgeolocation.io).
@@ -184,7 +187,7 @@ This is useful if:
184187
- You're using the SDK from a **browser** or **server with allowed referrer/IP**
185188
- Your keyless usage is enabled in the dashboard, by adding your domain name as Request Origin in `Add API key` section.
186189

187-
See [this section](https://ipgeolocation.io/documentation.html#2request-origin-cors) for more details.
190+
See [this section](https://ipgeolocation.io/documentation/authorization-and-response-formats.html#request-origin-cors) for more details.
188191

189192
In this case, just skip setting the API key, and the API will automatically detect your request origin:
190193
```javascript
@@ -210,7 +213,7 @@ This section shows how to use the `getIpGeolocation()` method from the JavaScrip
210213
- `dma`
211214
- `timezone`
212215

213-
For the full list of supported fields/modules, refer to the [IP Geolocation API Docs](https://ipgeolocation.io/ip-location-api.html#documentation-overview).
216+
For the full list of supported fields/modules, refer to the [IP Geolocation API Docs](https://ipgeolocation.io/documentation/ip-location-api.html).
214217

215218
The `ip` parameter in the SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the `ip=` parameter is not specified, the API will return information about the public IP of the machine.
216219

@@ -640,7 +643,7 @@ api.getBulkIpGeolocation(bulkRequest, {
640643
## IP Security Examples
641644
The `getIpSecurityInfo()` method lets you query threat intelligence, proxy/VPN detection, and risk metadata for IP addresses.
642645

643-
For full endpoint specifications, refer to the [IP Security API documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
646+
For full endpoint specifications, refer to the [IP Security API documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
644647

645648
### Get Security API Default Fields
646649
```javascript
@@ -849,7 +852,7 @@ This section provides usage examples of the `getAsnInfo()` method from the SDK.
849852
> [!NOTE]
850853
> ASN API is only available in the Advanced subscription plans.
851854
852-
Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
855+
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.
853856
### Get ASN Information by IP Address
854857
```javascript
855858
const { APIClient, ASNLookupAPI } = require('ip-geolocation-api-javascript-sdk');
@@ -1010,7 +1013,7 @@ You can retrieve data like the responsible organization, role, contact emails, p
10101013
> [!NOTE]
10111014
> Abuse Contact API is only available in the **Advanced Plan**.
10121015
1013-
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
1016+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
10141017

10151018
### Lookup Abuse Contact by IP
10161019
```javascript
@@ -1113,7 +1116,7 @@ Sample Response:
11131116
## Timezone API Examples
11141117
This section provides usage examples of the `getTimezoneInfo()` method from the JavaScript 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.
11151118

1116-
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/timezone-api.html#documentation-overview).
1119+
For full API specifications, refer to the [Timezone API documentation](https://ipgeolocation.io/documentation/timezone-api.html).
11171120

11181121
### Get Timezone by IP Address
11191122

@@ -1503,7 +1506,7 @@ Sample Response:
15031506
## Timezone Converter API Examples
15041507
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.
15051508

1506-
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/timezone-api.html#convert-time-bw-time-zones).
1509+
For more details, refer to the [Timezone Converter API documentation](https://ipgeolocation.io/documentation/timezone-api.html#convert-time-between-time-zones).
15071510

15081511
### Convert Current Time from One Timezone to Another
15091512
```javascript
@@ -1550,7 +1553,7 @@ Simply provide the appropriate source and target parameters in the method.
15501553

15511554
This section provides usage examples of the `getUserAgentDetails()` and `parseBulkUserAgentStrings()` methods from the JavaScript SDK. The **User Agent API** extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.
15521555

1553-
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/user-agent-api.html#documentation-overview).
1556+
For full explanation, visit the [User Agent API documentation](https://ipgeolocation.io/documentation/user-agent-api.html).
15541557

15551558
### Parse a Basic User Agent String
15561559

@@ -1635,7 +1638,7 @@ apiInstance.parseBulkUserAgentStrings(opts, (error, data, response) => {
16351638
## Astronomy API Examples
16361639
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**.
16371640

1638-
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/astronomy-api.html#documentation-overview) for more details.
1641+
Refer to the official [Astronomy API documentation](https://ipgeolocation.io/documentation/astronomy-api.html) for more details.
16391642

16401643
### Lookup Astronomy API by Coordinates
16411644
```javascript

0 commit comments

Comments
 (0)