Skip to content

Commit 9be69dd

Browse files
committed
replaced documentation links to new ones
1 parent da11d7a commit 9be69dd

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Based on:
3131
- [Download and build from source](#download-and-build-from-source)
3232
- [Using Download Prebuilt Binaries](#using-download-prebuilt-binaries)
3333
- [Troubleshooting](#troubleshooting)
34-
3. [API Plan Tiers and Documentation](#api-plan-tiers-and-documentation)
34+
3. [API Documentation Links](#api-documentations)
3535
4. [Fields and commands Availability](#fields-and-commands-availability)
3636
5. [Authentication Setup](#authentication-setup)
3737
- [How to Get Your API Key](#how-to-get-your-api-key)
@@ -216,14 +216,17 @@ The CLI provides geolocation information, timezone, user-agent parsing, bulk IP
216216
- **Wrong architecture:** Download the binary matching your OS and CPU architecture.
217217
- **Go install issues:** Use `GOPROXY=direct` if Go module proxy caching creates issues.
218218

219-
## API Plan Tiers and Documentation
219+
## API Documentations
220220

221-
The documentation below corresponds to the four available API tier plans:
222-
223-
- **Developer Plan** (Free): [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Free)
224-
- **Standard Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Standard)
225-
- **Advance Plan**: [Full Documentation](https://ipgeolocation.io/ip-location-api.html#Advance)
226-
- **Security Plan**: [Full Documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview)
221+
The documentation below corresponds to the available APIs:
222+
- [**Overview**](https://ipgeolocation.io/documentation.html)
223+
- [**IP GeoLocation API**](https://ipgeolocation.io/documentation/ip-location-api.html)
224+
- [**IP Security API**](https://ipgeolocation.io/documentation/ip-security-api.html)
225+
- [**ASN API**](https://ipgeolocation.io/documentation/asn-api.html)
226+
- [**IP Abuse Contact API**](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html)
227+
- [**Timezone API**](https://ipgeolocation.io/documentation/timezone-api.html)
228+
- [**User-Agent API**](https://ipgeolocation.io/documentation/user-agent-api.html)
229+
- [**Astronomy API**](https://ipgeolocation.io/documentation/astronomy-api.html)
227230

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

@@ -247,7 +250,7 @@ IP Geolocation offers four plans from billing point of view: **Free, Standard, S
247250
| `parse-bulk-user-agents` | Parse multiple User Agent String at once. |||||
248251

249252
> [!TIP]
250-
> 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).
253+
> 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).
251254
252255
## Authentication Setup
253256
To authenticate API requests, you need to get an API key from [ipgeolocation.io](https://ipgeolocation.io/).
@@ -316,7 +319,7 @@ ipgeolocation ipgeo [flags]
316319
| `--output` | string | `pretty` | Output format: `pretty`, `raw`, `table`, `yaml`. |
317320

318321
> [!NOTE]
319-
> Available language options can be found here: [https://ipgeolocation.io/ip-location-api.html#response-in-multiple-languages](https://ipgeolocation.io/ip-location-api.html#response-in-multiple-languages)
322+
> Available language options can be found here: [https://ipgeolocation.io/documentation/ip-location-api.html#response-in-multiple-languages](https://ipgeolocation.io/documentation/ip-location-api.html#response-in-multiple-languages)
320323
321324
#### Developer Plan Examples
322325
Get info about your current IP:
@@ -750,7 +753,7 @@ ipgeolocation bulk-ip-geo [flags]
750753
| `--output-file` | string | `""` | Save output to JSON file. Example: `--output-file results` |
751754

752755

753-
For further information, please visit [IP Geolocation API Documentation](https://ipgeolocation.io/ip-location-api.html#documentation-overview).
756+
For further information, please visit [IP Geolocation API Documentation](https://ipgeolocation.io/documentation/ip-location-api.html).
754757

755758
Lookup 3 IP addresses:
756759
```bash
@@ -847,7 +850,7 @@ ipgeolocation ip-security --ip 8.8.8.8 --output=yaml
847850
> [!NOTE]
848851
> You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.
849852
850-
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/ip-security-api.html#documentation-overview).
853+
For full API specifications, refer to the [official IP Security API documentation](https://ipgeolocation.io/documentation/ip-security-api.html).
851854

852855
#### Request with Field Filtering `ip-security`
853856
```bash
@@ -913,7 +916,7 @@ Save results to JSON file:
913916
ipgeolocation bulk-ip-security --ips=8.8.8.8,1.1.1.1 --output-file=output
914917
```
915918

916-
For further information, please visit [Bulk IP Security API Documentation](https://ipgeolocation.io/ip-security-api.html#bulk-ip-security-lookup-api).
919+
For further information, please visit [Bulk IP Security API Documentation](https://ipgeolocation.io/documentation/ip-security-api.html#bulk-ip-security-lookup-endpoint).
917920

918921
### `asn` Command
919922
Lookup ASN (Autonomous System Number) information using the `ipgeolocation.io` API.
@@ -1065,7 +1068,7 @@ Output as YAML:
10651068
ipgeolocation asn --ip 8.8.8.8 --output=yaml
10661069
```
10671070

1068-
For further information, please visit [ASN API Documentation](https://ipgeolocation.io/asn-api.html#documentation-overview).
1071+
For further information, please visit [ASN API Documentation](https://ipgeolocation.io/documentation/asn-api.html).
10691072

10701073
### `abuse` Command
10711074
Lookup IP abuse contact information using the `ipgeolocation.io` API.
@@ -1142,12 +1145,12 @@ abuse:
11421145
ip: 8.8.8.8
11431146
```
11441147
1145-
For further information, please visit [Abuse API Documentation](https://ipgeolocation.io/ip-abuse-contact-api.html#documentation-overview).
1148+
For further information, please visit [Abuse API Documentation](https://ipgeolocation.io/documentation/ip-abuse-contact-api.html).
11461149
11471150
### `timezone` Command
11481151
Lookup timezone information using the `ipgeolocation.io` API using different query types like IP address, latitude/longitude, and timezone ID.
11491152

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

11521155
#### `timezone` Usage
11531156
```bash
@@ -1532,7 +1535,7 @@ ipgeolocation timezone --ip 8.8.8.8 --output=yaml
15321535
### `time-conversion` Command
15331536
Convert between timezones using the `ipgeolocation.io` API to convert a specific time from one timezone to another using timezone identifiers and optional date/time inputs.
15341537

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

15371540
#### `time-conversion` Usage
15381541
```bash
@@ -1617,7 +1620,7 @@ The `astronomy` command uses the ipgeolocation.io Astronomy API to fetch astrono
16171620

16181621
You can specify the location using IP, city name, coordinates, or timezone.
16191622

1620-
For further information, please visit [Astronomy API Documentation](https://ipgeolocation.io/astronomy-api.html#documentation-overview).
1623+
For further information, please visit [Astronomy API Documentation](https://ipgeolocation.io/documentation/astronomy-api.html).
16211624

16221625
#### `astronomy` Usage
16231626
```bash
@@ -1867,7 +1870,7 @@ The `astronomy-timeseries` command uses the ipgeolocation.io Astronomy API to fe
18671870
- Day length
18681871
- Timezone-based or coordinate-based location support
18691872

1870-
For further information, please visit [Astronomy Timeseries API Documentation](https://ipgeolocation.io/astronomy-api.html#time-series-lookup).
1873+
For further information, please visit [Astronomy Timeseries API Documentation](https://ipgeolocation.io/documentation/astronomy-api.html#time-series-lookup).
18711874

18721875
#### `astronomy-timeseries` Usage
18731876
```bash
@@ -2023,7 +2026,7 @@ ipgeolocation parse-user-agent [flags]
20232026
| `--user-agent` | string | `""` | User agent string. |
20242027
| `--output` | string | `pretty` | Output format: `pretty`, `raw`, `table`, `yaml`. |
20252028

2026-
For further information, please visit [User Agent Parser API Documentation](https://ipgeolocation.io/user-agent-api.html#documentation-overview).
2029+
For further information, please visit [User Agent Parser API Documentation](https://ipgeolocation.io/documentation/user-agent-api.html).
20272030

20282031
#### Parse a user agent string
20292032
```bash
@@ -2080,7 +2083,7 @@ ipgeolocation parse-bulk-user-agents [flags]
20802083
| `--user-agents` | string[] | `[]` | User agent strings. |
20812084
| `--output` | string | `pretty` | Output format: `pretty`, `raw`, `table`, `yaml`. |
20822085

2083-
For further information, please visit [Bulk User Agent Parser API Documentation](https://ipgeolocation.io/user-agent-api.html#parse-bulk-ua-strings).
2086+
For further information, please visit [Bulk User Agent Parser API Documentation](https://ipgeolocation.io/documentation/user-agent-api.html#parse-bulk-user-agent-strings).
20842087

20852088
> [!NOTE]
20862089
> - The `user-agents` flag is required.

0 commit comments

Comments
 (0)