IP Location API
IP Location offers a strong, continuous IP to geolocation Programming interface equipped for looking up precise location data and assessing security threats originating from dangerous IP addresses. Results are delivered within milliseconds in JSON format. Using the IP Location API you will be able to locate website visitors at first glance and adjust your user experience and application accordingly.
This documentation outlines the detailed workings of the API.
Quick start Guide
All registered users can use our Quick start guide to try out all API functionalities at the click of a button. If you're already a registered user, you need to view our Quick start guide first. If not, you will need to first quickly setup your account and register yourself.
Step 1: User Registration
The User Registration is a crucial component of the IP Location Finder application, allowing you to create an account and securely access the application's features.
You need to enter your account details, such as account name, email and password. The user registration ensures that each user's information is stored securely and that duplicate accounts are prevented.
Step 2: User Login
Now you should navigate to the login page after registration, you must log in to your account using your email and password. Upon successful login, you can generate an API key to access IP details.
Step 3: Generate an API Key
After successful registration and login, you are required to generate an API key based on your account details. This API key will allow you to access IP details.
You will be asked to enter a description to generate your API key. For Example:
{
"description": "Hello! I am generating my API key"
}
In response, you will be provided with your API key. Your API key will appear as follows:
{
"apiKey": "bk8TKpZMyVQ+luV/fac5w8MvJ3zwtapkZ+5TRw=="
}
Getting Started
API Key
Your API Access Key is your unique authentication key used to gain access to the IP location API.
After completing all the above steps, you are ready to access IP Location to get your API response.
API Response
The IP Location API will give you information in JSON format (which is the default). Below is an example of what the IP Location API would return when you ask it about the IP address 203.175.73.40 using the API call:
{
"ipAddress": "184.169.250.146",
"country": "United States",
"city": "San Jose",
"state": "California",
"postalCode": "95141",
"latitude": "37.1835",
"longitude": "-121.7714"
}
API responses include extensive location-related data, offering details such as country, city, state, postal code, latitude, and longitude coordinates.
Error Codes
If an issue arises where the requested resource is unavailable or an API call fails, the IP Location API will return a JSON error containing crucial information: an error code and a descriptive message to assist in identifying the problem.
Example Error: If your daily API request volume limit has been exceeded, the following error will be returned:
API Key limit exceeded. Please generate a new API Key
Some of the other errors are as below:
| Code | Type | Info |
|---|---|---|
| 404 | 404_not_found | The requested resource does not exist. |
| 429 | too_many_requests | The HTTP 429 error is returned when a user has sent too many requests within a short period of time. |
| 500 | internal_server_error | The "HTTP Error 500" or "Internal Server Error" is a temporary error message that indicates an issue on the web server side. |