Connector Details
Type
SaaS & APIs
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Geolocation Services
IP Geolocation API
Overview
The IPify Geolocation API enables developers to retrieve geolocation data (country, city) and detect VPN or proxy usage for a given IP address. This API is accessible via a simple HTTP GET request and supports a default API key for immediate integration.
Integration Overview
The IPify Geolocation API supports the following integration points:
Country Geolocation Integration
-
- : Retrieves country-level geolocation data for an IP address.
Country and City Geolocation Integration
-
- : Retrieves both country and city-level geolocation data.
VPN/Proxy Detection Integration
- : Retrieves country, city, and VPN/proxy detection information.
Detailed Integration Documentation
Country Geolocation Integration
Purpose
Retrieves country-level geolocation information for a specified IP address or the caller’s IP if none is provided.
Operation
getCountryGeolocation
Input Details
- Required Fields:
- apiKey: API key for authentication (default: at_7DjJpEYCnikNNhcQUtPTJfIzt7h25).
- Optional Fields:
- ipAddress: The IP address to query (e.g., 8.8.8.8). If omitted, the API uses the caller’s IP.
Output
- Successful: Returns a JSON object containing country-level geolocation data.
- Failure: Returns an error message (e.g., invalid API key or IP address).
Workflow Example
1. Include the default API key in the query.
2. Optionally specify an IP address to query.
3. Send a GET request to /api/v2/country with parameters apiKey and ipAddress.
4. Parse the JSON response to extract country information.
Country and City Geolocation Integration
Purpose
Retrieves both country and city-level geolocation information for a specified IP address or the caller’s IP.
Operation
getCountryCityGeolocation
Input Details
- Required Fields:
- apiKey: API key for authentication (default: at_7DjJpEYCnikNNhcQUtPTJfIzt7h25).
- Optional Fields:
- ipAddress: The IP address to query (e.g., 8.8.8.8). If omitted, the API uses the caller’s IP.
Output
- Successful:Returns a JSON object containing country and city-level geolocation data.
- Failure: Returns an error message (e.g., invalid API key or IP address).
Workflow Example
1. Include the default API key in the query.
2. Optionally specify an IP address to query.
3. Send a GET request to /api/v2/country,city with parameters apiKey and ipAddress.
4. Parse the JSON response to extract country and city information.
VPN/Proxy Detection Integration
Purpose
Retrieves country, city, and VPN/proxy detection information for a specified IP address or the caller’s IP.
Operation
getCountryCityVpnGeolocation
Input Details
- Required Fields:
- apiKey: API key for authentication (default: at_7DjJpEYCnikNNhcQUtPTJfIzt7h25).
- Optional Fields:
- ipAddress: The IP address to query (e.g., 8.8.8.8). If omitted, the API uses the caller’s IP.
Output
- Successful:Returns a JSON object containing country, city, and VPN/proxy detection data.
- Failure:Returns an error message (e.g., invalid API key or IP address).
Workflow Example
1. Include the default API key in the query.
2. Optionally specify an IP address to query.
3. Send a GET request to /api/v2/country,city,vpn with parameters apiKey and ipAddress.
4. Parse the JSON response to extract geolocation and VPN/proxy information.
Workflow Creation with the API
Example Workflow: Retrieving Geolocation and VPN Data for an IP Address
Prepare Request
Decide the level of detail needed (country, city, or VPN/proxy detection).
Query Country Information
- Use the Country and City Geolocation Integration for more granular data.
- Example: Send a GET request to /api/v2/country,city with apiKey and ipAddress=8.8.8.8.
Query City Information (if needed)
- Encode the XML invoice using Base64.
- Use the Clearance integration to submit the invoice for stamping.
- Retrieve the stamped invoice from the response.
Check VPN/Proxy Usage (if needed)
- Use the VPN/Proxy Detection Integration to identify VPN or proxy usage.
- Example: Send a GET request to /api/v2/country,city,vpn with apiKey and ipAddress=8.8.8.8.
Parse and Store Results
Store the JSON response for use in your application (e.g., displaying location or flagging VPN usage).
Monitor API Usage
Track API calls to stay within rate limits using logging tools.
Additional Notes
- The default API key (at_7DjJpEYCnikNNhcQUtPTJfIzt7h25) is provided for testing but may have usage limits. For production, register for a personal API key.
- Ensure the ipAddress parameter is a valid IPv4 or IPv6 address to avoid errors.
- Responses are returned in JSON format; always validate the response structure before processing.
- Use HTTPS for all requests to ensure secure communication.
- For high-volume applications, consider implementing caching to reduce API calls and improve performance.
Pricing
iSolution logo - white - transparent 250 px