Skip to content

Commit 2774fd7

Browse files
Merge pull request #22 from IPGeolocation/sameer
Updated README.md file
2 parents 141bd1e + 69b1897 commit 2774fd7

File tree

1 file changed

+54
-8
lines changed

1 file changed

+54
-8
lines changed

README.md

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,60 @@
1-
# ipgeolocation-sdk-java
1+
# ipgeolocation-java-sdk
22

33
IPGeolocation.io - IP intelligence products
44
- API version: 2.0
5-
- Generator version: 7.13.0
65

76
Ipgeolocation provides a set of APIs to make ip based decisions.
87

9-
10-
11-
# 📦 Installation
8+
## Table of Contents
9+
10+
1. [Installation](#installation)
11+
- [Maven](#maven)
12+
- [Gradle](#gradle)
13+
- [Manual Installation](#manual-installation)
14+
2. [Authentication Setup](#authentication-setup)
15+
16+
3. [IP Geolocation Examples](#ip-geolocation-examples)
17+
- [1. Basic Plan Examples](#1-basic-plan-examples)
18+
- [2. Standard Plan Examples](#2-standard-plan-examples)
19+
- [3. Advanced Plan Examples](#3-advanced-plan-examples)
20+
- [Bulk IP Geolocation Example](#bulk-ip-geolocation-example)
21+
22+
4. [IP Security Examples](#ip-security-examples)
23+
- [Basic Request (Minimal Setup)](#basic-request-minimal-setup)
24+
- [Include Multiple Optional Fields](#include-multiple-optional-fields)
25+
- [Request with Field Filtering](#request-with-field-filtering)
26+
- [Bulk IP Security Request](#bulk-ip-security-request)
27+
28+
5. [ASN API Examples](#asn-api-examples)
29+
- [Get ASN Information by IP Address](#get-asn-information-by-ip-address)
30+
- [Get ASN Information by ASN Number](#get-asn-information-by-asn-number)
31+
- [Combine All objects using Include](#combine-all-objects-using-include)
32+
33+
6. [Timezone API Examples](#timezone-api-examples)
34+
- [Get Timezone by IP Address](#get-timezone-by-ip-address)
35+
- [Get Timezone by Timezone Name](#get-timezone-by-timezone-name)
36+
- [Get Timezone from Any Address](#get-timezone-from-any-address)
37+
- [Get Timezone from Location Coordinates](#get-timezone-from-location-coordinates)
38+
- [Get Timezone and Airport Details from IATA Code](#get-timezone-and-airport-details-from-iata-code)
39+
- [Get Timezone and City Details from UN/LOCODE](#get-timezone-and-city-details-from-unlocode)
40+
41+
7. [Timezone Converter Examples](#timezone-converter-examples)
42+
- [Convert Current Time from One Timezone to Another](#convert-current-time-from-one-timezone-to-another)
43+
44+
8. [User Agent API Examples](#user-agent-api-examples)
45+
- [Parse a Basic User Agent String](#parse-a-basic-user-agent-string)
46+
- [Bulk User Agent Parsing Example](#bulk-user-agent-parsing-example)
47+
9. [Astronomy API Examples](#astronomy-api-examples)
48+
- [Astronomy by Coordinates](#astronomy-by-coordinates)
49+
- [Astronomy by IP Address](#astronomy-by-ip-address)
50+
- [Astronomy by Location String](#astronomy-by-location-string)
51+
- [Astronomy for Specific Date](#astronomy-for-specific-date)
52+
- [Astronomy in Different Language](#astronomy-in-different-language)
53+
54+
10. [Documentation for Models](#documentation-for-models)
55+
56+
57+
# Installation
1258

1359
## Requirements
1460
- **Java**: 1.8 or higher
@@ -55,7 +101,7 @@ Then include the following JARs in your classpath:
55101

56102
---
57103

58-
# 🔐 Authentication Setup
104+
# Authentication Setup
59105

60106
To authenticate API requests, you need an API key from [ipgeolocation.io](https://ipgeolocation.io/). Once obtained, configure your API client as follows:
61107

@@ -75,13 +121,13 @@ Ensure that your API key is securely stored and not exposed in public repositori
75121

76122
---
77123

78-
# 📘 Example Usage
124+
# Example Usage
79125

80126
## IP Geolocation Examples
81127

82128
This section provides usage examples of the `getIPGeolocation()` method from the SDK across Free, Standard, and Advanced subscription tiers. Each example highlights different combinations of parameters: `fields`, `include`, and `excludes`.
83129

84-
### 📌 Parameters
130+
### Parameters
85131

86132
#### `fields`
87133
Use this parameter to include specific fields in the response.

0 commit comments

Comments
 (0)