# IP Geo Location

## API Overview

## What is FireAPI IP Geo Location API?

The **FireAPI IP Geo Location API** is a REST-based service that allows you to fetch geographic and technical information related to an IPv4 or IPv6 address. It can automatically detect the visitor’s public IP or allow querying any custom IP address for detailed location intelligence.

This API is commonly used in applications for **geo-targeting**, **regional personalization**, **traffic analysis**, and **security monitoring**.

## 1. Get Client’s IP Address (Simple)

This endpoint returns the **public IP address** of the client making the request. It is the fastest and simplest method for detecting user IP without additional geolocation data.

### Key Features

- Automatically detects caller’s IPv4 or IPv6 address
- Lightweight response for fast integration
- Useful for logging and tracking requests

### Example Response

```json
{
  "ip": "203.0.113.45"
}
```

## 2. Get Client’s IP with Geolocation Data

This endpoint detects the caller’s IP address and returns **geolocation information** such as country, region, city, timezone, and coordinates. It is ideal for websites and apps that want to automatically localize content for visitors.

### Returned Data

- IP address
- Country and country code
- State/region and city
- Latitude and longitude
- Timezone

### Example Response

```json
{
  "ip": "203.0.113.45",
  "country": "United States",
  "country_code": "US",
  "region": "California",
  "city": "Los Angeles",
  "lat": 34.0522,
  "lon": -118.2437,
  "timezone": "America/Los_Angeles"
}
```

## 3. Get Detailed Geolocation Info for Any IP

This endpoint allows you to send any IP address and retrieve **detailed geolocation** and **network metadata**. It is the best option for fraud detection systems, security tools, and advanced analytics dashboards.

### Best Use Cases

- Fraud prevention and suspicious login detection
- Geo-blocking and compliance validation
- Traffic source and visitor analytics
- Investigating unknown IP addresses

### Returned Data

- Continent, country, region, city
- Postal/ZIP code
- Latitude and longitude
- Timezone and UTC offset
- ISP and organization
- ASN (Autonomous System Number)
- Hosting / proxy / VPN indicators (if supported)

### Example Response

```json
{
  "ip": "8.8.8.8",
  "continent": "North America",
  "country": "United States",
  "country_code": "US",
  "region": "California",
  "city": "Mountain View",
  "postal": "94035",
  "lat": 37.386,
  "lon": -122.0838,
  "timezone": "America/Los_Angeles",
  "isp": "Google LLC",
  "asn": "AS15169",
  "org": "Google Public DNS"
}
```

## 4. Get Basic IP Information

This endpoint returns **basic IP metadata** such as ISP, ASN, and country code. It is suitable for lightweight applications where full city-level geolocation is not required.

### Common Output Fields

- IP address
- Country code
- ISP (Internet Service Provider)
- ASN information

### Example Response

```json
{
  "ip": "8.8.8.8",
  "country": "US",
  "isp": "Google LLC",
  "asn": "AS15169"
}
```

## FireAPI IP Geo Location API Response Fields

FireAPI provides multiple response attributes depending on the endpoint type. Below are the most common fields returned in IP geolocation responses.

### Geographic Data

- **continent** - Continent name
- **country** - Country name
- **country_code** - ISO country code
- **region** - State or region
- **city** - City name
- **postal** - Postal or ZIP code

### Coordinates and Timezone

- **lat** - Latitude coordinate
- **lon** - Longitude coordinate
- **timezone** - Timezone name
- **utc_offset** - Offset from UTC

### Network & ISP Information

- **isp** - Internet Service Provider
- **org** - Organization name
- **asn** - Autonomous System Number

## Why Use FireAPI IP Geo Location API?

FireAPI’s IP Geo Location service is designed to help businesses and developers build location-aware applications with ease. By identifying the geographic location of users, you can improve security, provide personalized experiences, and enhance decision-making.

### Main Benefits

- Accurate IP-based location lookup
- Fast API response time
- Supports IPv4 and IPv6
- Improves fraud detection and risk scoring
- Enables localization and geo-targeted content

## Important Notes About IP Geolocation

IP geolocation is an estimate based on public IP registry databases. Results may vary depending on the internet provider, mobile carrier routing, or VPN usage.

- City-level accuracy is not guaranteed for all IPs
- VPN and proxy users may show incorrect locations
- Mobile networks may return the carrier headquarters instead of user city.
