Skip to content

replaced documentation links to new ones #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DaudAhmadJF wants to merge 1 commit into
base: master
Choose a base branch
from
Open

replaced documentation links to new ones #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Based on:
2. [Installation](#installation)
- [From PyPI](#from-pypi)
- [From GitHub](#from-github)
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
3. [API Documentation Links](#api-documentations)
4. [API Endpoints](#api-endpoints)
5. [Fields and Methods Availability](#fields-and-methods-availability)
6. [Authentication Setup](#authentication-setup)
Expand Down Expand Up @@ -98,14 +98,17 @@ Then import the package:
import ipgeolocation
```

## API Plan Tiers and Documentation
## API Documentations

The documentation below corresponds to the four available API tier plans:

- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
The documentation below corresponds to the available APIs:
- [**Overview**](https://ipgeolocation.io/documentation.html)
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)

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

Expand Down Expand Up @@ -149,7 +152,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
| *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) | ✖ | ✔ | ✔ | ✔ |

> [!TIP]
> 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).
> 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).

## Authentication Setup
To authenticate API requests, you need to get an API key from [ipgeolocation.io](https://ipgeolocation.io/).
Expand Down Expand Up @@ -210,7 +213,7 @@ This section provides usage examples of the `get_ip_geolocation()` method from t
- `dma`
- `time_zone`

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

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.

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

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.

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

---

Expand Down Expand Up @@ -646,7 +649,7 @@ with ipgeolocation.ApiClient(configuration) as client:
pprint(response.to_dict())
```
> [!NOTE]
> You can get all the available fields in standard plan in combination with security data.
> You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.

### Request with Field Filtering
```python
Expand Down Expand Up @@ -685,7 +688,7 @@ This section provides usage examples of the `get_asn_info()` method from the SDK
> [!NOTE]
> ASN API is only available in the Advanced Plan

Refer to the [ASN API documentation](https://ipgeolocation.io/asn-api.html#documentation-overview) for a detailed list of supported fields and behaviors.
Refer to the [ASN API documentation](https://ipgeolocation.io/documentation/asn-api.html) for a detailed list of supported fields and behaviors.

### Get ASN Information by IP Address
```python
Expand Down Expand Up @@ -816,7 +819,7 @@ This section demonstrates how to use the `get_abuse_contact_info()` method of th
> [!NOTE]
> Abuse Contact API is only available in the Advanced Plan

Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview) for details on all available fields.
Refer to the official [Abuse Contact API documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html) for details on all available fields.
### Lookup Abuse Contact by IP
```python
with ipgeolocation.ApiClient(configuration) as client:
Expand Down Expand Up @@ -895,7 +898,7 @@ Sample Response:

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.

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

### Get Timezone by IP Address
```python
Expand Down Expand Up @@ -1242,7 +1245,7 @@ Sample Response:

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.

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

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

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.

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

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

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.

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

### Lookup Astronomy API by Coordinates
```python
Expand Down