Getting started overview

Getting started with the IP Address Details API involves a few key steps: creating an account, retrieving your API key, and executing your initial API request. The IP Address Details API is designed as a RESTful service, providing IP geolocation and related data in JSON format. The free tier offers up to 1,000 requests per day, making it suitable for testing and low-volume applications IP Address Details pricing. Paid plans begin at $10 per month for 50,000 requests.

The core functionality focuses on identifying an IP address's geographical location, detecting VPN or proxy usage, and performing ASN/ISP lookups IP Address Details API documentation. This guide will walk through the process of making your first request to the IP Geolocation API endpoint.

Quick Reference: Getting Started Steps

Step What to Do Where
1. Create Account Register for a new account. IP Address Details sign-up page
2. Get API Key Locate and copy your unique API key. Your IP Address Details dashboard
3. Make First Request Construct and send an HTTP GET request to the API endpoint. Your preferred HTTP client (e.g., cURL, Postman) or programming language.
4. Parse Response Process the JSON data returned by the API. Your application's code.

Create an account and get keys

To begin using the IP Address Details API, you need to create an account. This process grants you access to your personal dashboard, where your API key is generated and stored.

  1. Navigate to the Sign-up Page: Open your web browser and go to the official IP Address Details sign-up page.
  2. Provide Account Details: Enter the required information, typically including your email address and a secure password. Agree to any terms of service.
  3. Complete Registration: Follow the on-screen prompts to finalize your account creation. You may need to verify your email address through a confirmation link sent to your inbox.
  4. Access Your Dashboard: Once registered and logged in, you will be redirected to your IP Address Details dashboard.
  5. Locate Your API Key: On your dashboard, find the section labeled 'API Key' or similar. Your unique API key will be displayed there. This key is essential for authenticating your API requests. Copy this key and store it securely, as it acts as your credential for accessing the API.

The API key is a string of alphanumeric characters that the API uses to identify and authenticate your requests. Without it, the API will reject your calls. API keys are a common method for authenticating access to web services Mozilla API key definition, providing a simple yet effective way to manage access control.

Your first request

With your API key in hand, you can now make your first request to the IP Geolocation API. This example uses a simple HTTP GET request to retrieve details for a specified IP address. The API supports both IPv4 and IPv6 addresses.

API Endpoint Structure

The base URL for the API is api.ipaddressdetails.com. The endpoint for IP geolocation lookups typically follows this pattern:

GET https://api.ipaddressdetails.com/ip/{ip_address}?access_key={your_api_key}

Replace {ip_address} with the IP address you want to query, and {your_api_key} with the key obtained from your dashboard.

Example Request (cURL)

Using cURL is a straightforward way to test API endpoints from the command line. Open your terminal or command prompt and execute the following command, replacing the placeholder values:

curl "https://api.ipaddressdetails.com/ip/8.8.8.8?access_key=YOUR_API_KEY_HERE"

This command queries the IP address 8.8.8.8 (Google's Public DNS) and includes your API key for authentication. A successful response will return a JSON object containing geolocation data.

Example JSON Response

A typical successful response for 8.8.8.8 might look like this (abbreviated):

{
  "ip_address": "8.8.8.8",
  "type": "ipv4",
  "continent_code": "NA",
  "continent_name": "North America",
  "country_code": "US",
  "country_name": "United States",
  "region_code": "CA",
  "region_name": "California",
  "city": "Mountain View",
  "zip": "94043",
  "latitude": 37.38605, 
  "longitude": -122.08385,
  "location": {
    "geoname_id": 5375480,
    "capital": "Washington D.C.",
    "languages": [
      {
        "code": "en",
        "name": "English",
        "native": "English"
      }
    ],
    "country_flag": "https://assets.ipaddressdetails.com/flags/us.svg",
    "country_flag_emoji": "🇺🇸",
    "country_flag_emoji_unicode": "U+1F1FA U+1F1F8",
    "calling_code": "1",
    "is_eu": false
  },
  "asn": {
    "asn": "AS15169",
    "name": "Google LLC",
    "domain": "google.com",
    "type": "isp"
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  },
  "time_zone": {
    "id": "America/Los_Angeles",
    "current_time": "2026-05-29T10:30:00-07:00",
    "gmt_offset": -25200,
    "code": "PDT",
    "is_daylight_saving": true
  }
}

Common next steps

After successfully making your first IP Address Details API call, consider these common next steps to integrate and optimize the API within your applications:

  1. Integrate into an Application: Move beyond cURL and integrate the API call into your preferred programming language (e.g., Python, Node.js, PHP, Ruby). Libraries for making HTTP requests are widely available across most languages. For example, Python's requests library simplifies HTTP interactions.
  2. Error Handling: Implement robust error handling in your code. The API will return specific HTTP status codes and error messages in the JSON response for failed requests (e.g., invalid API key, rate limit exceeded, invalid IP address). Refer to the IP Address Details API documentation for a list of common error codes and their meanings.
  3. Explore Additional Endpoints: Beyond basic IP geolocation, IP Address Details offers other functionalities like VPN/Proxy Detection and ASN/ISP Lookup. Investigate these endpoints if your use case requires more detailed network insights.
  4. Monitor Usage: Regularly check your API usage from your IP Address Details dashboard to ensure you stay within your free tier limits or your subscribed plan. This helps prevent unexpected service interruptions due to rate limits.
  5. Upgrade Plan (if needed): If your application requires more than 1,000 requests per day, consider upgrading to a paid plan. IP Address Details offers various tiers starting from 50,000 requests per month for $10 IP Address Details pricing details.
  6. Secure Your API Key: Never expose your API key directly in client-side code (e.g., JavaScript in a browser). For web applications, always make API calls from your backend server to protect your key. If building a mobile app, consider using environment variables or a secure key management service.

Troubleshooting the first call

If your first API call doesn't return the expected JSON response, consider the following troubleshooting steps:

  1. Check Your API Key: Ensure that the access_key parameter in your request exactly matches the API key found on your IP Address Details dashboard. Even a single incorrect character will result in an authentication failure.
  2. Verify the Endpoint URL: Double-check the entire URL, including the base domain, path, and query parameters. A common mistake is a typo in the domain name or an incorrectly formatted parameter. The correct base URL is https://api.ipaddressdetails.com/ip/{ip_address}?access_key={your_api_key}.
  3. Inspect the IP Address: Ensure the IP address you are querying is valid. Using a malformed IP address will lead to an error.
  4. Review HTTP Status Codes: The API will return standard HTTP status codes. Common error codes include:
    • 401 Unauthorized: Indicates an invalid or missing API key.
    • 403 Forbidden: May indicate a rate limit violation or insufficient plan permissions.
    • 404 Not Found: Though less common for this API, it could indicate a malformed endpoint path.
    • 422 Unprocessable Entity: Often returned for invalid input, such as an incorrectly formatted IP address.
    Consult the IP Address Details API documentation for specific error code explanations.
  5. Check Network Connectivity: Ensure your machine has an active internet connection and that no firewalls or proxies are blocking your outgoing HTTP requests to api.ipaddressdetails.com.
  6. Consult Documentation: The official documentation for IP Address Details provides detailed information on all endpoints, parameters, and error responses. Review it for specific guidance related to your issue.

By systematically checking these points, you can often identify and resolve issues preventing a successful first API call.