📌 API Overview

The IP Geolocation API allows you to identify the approximate geographical location and network information associated with an IP address.

The API response may include:

• 🌎 Continent and country information
• 🏙️ Region, city, and postal code
• 📍 Latitude and longitude
• 💰 Local currency information
• 🕒 Timezone and current local time
• 🌐 ISP, organization, and ASN details
• 🛡️ VPN, proxy, Tor, hosting, and security detection

🔗 Endpoint

GET https://apipeak.dev/api/ipgeolocation

🔐 Authentication

This endpoint requires an API key. Include your API key in the X-API-KEY request header.

X-API-KEY: YOUR_API_KEY

Replace YOUR_API_KEY with your actual API Peak API key.

📥 Request Parameters

📨 Request Headers

📖 Response Fields

🌐 Root Response

📍 Location Object

🏳️ Country Object

💰 Currency Object

🕒 Timezone Object

📡 Network Object

🛡️ Security Object

⚠️ Error Responses

400 Bad Request

Returned when the IP parameter is missing, empty, or incorrectly formatted.

{
```

"message": "The IP address field is required."
}

401 Unauthorized

Returned when the API key is missing or invalid.

{
```

"message": "Invalid or missing API key."
}

422 Unprocessable Entity

Returned when the submitted IP address cannot be validated.

{
```

"message": "The provided IP address is invalid."
}

429 Too Many Requests

Returned when your account has exceeded its request or usage limit.

{
```

"message": "API usage limit exceeded."
}

500 Internal Server Error

Returned when an unexpected server error occurs.

{
```

"message": "Unable to process the request."
}

📊 HTTP Status Codes

💡 Common Use Cases

• 🌍 Display country-specific content
• 💰 Show prices in the visitor's local currency
• 🕒 Convert dates and times to the user's timezone
• 🗣️ Select a suitable language automatically
• 🛡️ Detect suspicious VPN, proxy, or Tor traffic
• 📊 Analyse website traffic by location
• 📍 Personalise applications based on region or city
• 🚫 Apply country or region access restrictions
• 📡 Identify the user's ISP and network organization

📝 Important Notes

• IP geolocation results are approximate and should not be treated as an exact physical address.
• City, region, postal code, and coordinate accuracy may vary depending on the IP address and network provider.
• VPN, proxy, hosting, crawler, and Tor detection should be used as risk indicators rather than absolute proof.
• The current_time value is generated using the detected timezone.
• Some response fields may return null when the information is unavailable.
• Never expose your API key in public repositories or client-side JavaScript.

🔒 API Key Security

To keep your API key secure:

• Store it in an environment variable.
• Send API requests from your backend server.
• Do not include the key in public GitHub repositories.
• Do not expose the key in browser source code.
• Regenerate the key immediately if it becomes compromised.