Skip to content

Commit ae7f492

Browse files
authored
replaced documentation links to new ones (#9)
1 parent 4e055ed commit ae7f492

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Based on:
2626
2. [Installation](#installation)
2727
- [From PyPI](#from-pypi)
2828
- [From GitHub](#from-github)
29-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
29+
3. [API Documentation Links](#api-documentations)
3030
4. [API Endpoints](#api-endpoints)
3131
5. [Fields and Methods Availability](#fields-and-methods-availability)
3232
6. [Authentication Setup](#authentication-setup)
@@ -98,14 +98,17 @@ Then import the package:
9898
import ipgeolocation
9999
```
100100

101-
## API Plan Tiers and Documentation
101+
## API Documentations
102102

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

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

@@ -149,7 +152,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
149152
| *UserAgentApi* | [**parse_bulk_user_agent_strings**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#parse_bulk_user_agent_strings) |||||
150153

151154
> [!TIP]
152-
> 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).
155+
> 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).
153156
154157
## Authentication Setup
155158
To authenticate API requests, you need to get an API key from [ipgeolocation.io](https://ipgeolocation.io/).
@@ -210,7 +213,7 @@ This section provides usage examples of the `get_ip_geolocation()` method from t
210213
- `dma`
211214
- `time_zone`
212215

213-
For complete details, refer to the official documentation: [IP Geolocation API Documentation](https://ipgeolocation.io/ip-location-api.html#documentation-overview)
216+
For complete details, refer to the official documentation: [IP Geolocation API Documentation](https://ipgeolocation.io/documentation/ip-location-api.html)
214217

215218
The `ip` parameter in the package can accept any valid IPv4 address, IPv6 address, or domain name. If `ip=` the parameter is omitted, the API will return information about the public IP address of the device or server where the package is executing.
216219

@@ -605,7 +608,7 @@ with ipgeolocation.ApiClient(configuration) as client:
605608

606609
This section provides usage examples of the `get_ip_security_info()` method from the SDK across various subscription tiers. Each example demonstrates different ways to query threat intelligence and risk metadata using parameters like fields, excludes, and optional modules.
607610

608-
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
611+
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
609612

610613
---
611614

@@ -646,7 +649,7 @@ with ipgeolocation.ApiClient(configuration) as client:
646649
pprint(response.to_dict())
647650
```
648651
> [!NOTE]
649-
> You can get all the available fields in standard plan in combination with security data.
652+
> You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.
650653
651654
### Request with Field Filtering
652655
```python
@@ -685,7 +688,7 @@ This section provides usage examples of the `get_asn_info()` method from the SDK
685688
> [!NOTE]
686689
> ASN API is only available in the Advanced Plan
687690
688-
Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
691+
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.
689692

690693
### Get ASN Information by IP Address
691694
```python
@@ -816,7 +819,7 @@ This section demonstrates how to use the `get_abuse_contact_info()` method of th
816819
> [!NOTE]
817820
> Abuse Contact API is only available in the Advanced Plan
818821
819-
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
822+
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
820823
### Lookup Abuse Contact by IP
821824
```python
822825
with ipgeolocation.ApiClient(configuration) as client:
@@ -895,7 +898,7 @@ Sample Response:
895898

896899
This section provides usage examples of the `get_timezone_info()` method from the SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, and timezone ID.
897900

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

900903
### Get Timezone by IP Address
901904
```python
@@ -1242,7 +1245,7 @@ Sample Response:
12421245

12431246
This section provides usage examples of the `convert_time_between_timezones()` 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.
12441247

1245-
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/timezone-api.html#convert-time-between-time-zones).
1248+
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/documentation/timezone-api.html#convert-time-between-time-zones).
12461249

12471250
### Convert Current Time from One Timezone to Another
12481251
```python
@@ -1266,7 +1269,7 @@ Similarly, you can convert time from any timezone to another timezone using loca
12661269

12671270
This section provides usage examples of the `parse_user_agent_string()` method from the SDK. The User Agent API extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.
12681271

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

12711274
### Parse a Basic User Agent String
12721275
```python
@@ -1323,7 +1326,7 @@ with ipgeolocation.ApiClient(configuration) as client:
13231326

13241327
This section provides usage examples of the `get_astronomy_details()` method from the SDK, allowing developers to fetch sun and moon timings and position data based on coordinates, IP, or location string.
13251328

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

13281331
### Lookup Astronomy API by Coordinates
13291332
```python

0 commit comments

Comments
 (0)