Getting started overview
This guide outlines the process for developers and technical users to begin integrating with the Intelligence X API. It covers account creation, obtaining necessary API credentials, and executing a foundational search request. Intelligence X provides programmatic access to its extensive collection of Open-Source Intelligence (OSINT) data, including data breaches, darknet monitoring, and historical internet data, supporting various security and investigative applications. The API is designed for automated data retrieval and integration into existing security workflows or custom tools.
Access to the Intelligence X API requires a paid subscription. The free tier offers limited search queries through the web interface but does not include API access. Once subscribed, users can generate API keys to authenticate their requests. The API supports various programming languages through official SDKs, simplifying the integration process.
The following table provides a high-level overview of the steps involved in getting started:
| Step | What to do | Where |
|---|---|---|
| 1. Create Account | Register for a user account | Intelligence X homepage |
| 2. Subscribe to Plan | Select and purchase a paid subscription plan (API access requires a paid plan) | Intelligence X pricing page |
| 3. Generate API Key | Access your account dashboard to generate a unique API key | Intelligence X API authentication documentation |
| 4. Install SDK (Optional) | Install the appropriate SDK for your programming language (e.g., Python, Go) | Intelligence X API documentation |
| 5. Make First Request | Construct and execute a basic search query using your API key | Code examples below, or Intelligence X search API quick start |
Create an account and get keys
To access the Intelligence X API, you must first create a user account and then subscribe to a paid plan. API access is not available on the free tier.
- Create an Intelligence X Account: Navigate to the Intelligence X homepage and register for a new account. This typically involves providing an email address and creating a password.
- Select a Paid Plan: After creating your account, proceed to the Intelligence X pricing page. Choose a subscription plan that meets your requirements. The Personal plan, starting at 29.99 EUR/month, is the entry-level option that provides API access. Enterprise-level plans are also available.
- Generate Your API Key: Once your subscription is active, log in to your Intelligence X account. Locate the API key generation section, typically found within your user profile or settings dashboard. Generate a new API key. This key is a unique alphanumeric string that authenticates your requests to the Intelligence X API. Treat your API key like a password; do not expose it in client-side code, public repositories, or unsecured environments. For secure handling of API keys, refer to general best practices for managing API keys securely in cloud environments or similar guidance from other providers like AWS access key best practices.
Your API key is essential for all authenticated API calls. Make sure to copy and store it securely.
Your first request
After obtaining your API key, you can make your first request. This example uses the Python SDK for a simple search query, as Python is one of the primary languages supported by Intelligence X for code examples.
First, install the Intelligence X Python SDK:
pip install intelx
Next, use the following Python code to perform a basic search. Replace YOUR_API_KEY with the key you generated.
import intelx
def search_intelx(api_key, query):
intelx_api = intelx.IntelligenceX(api_key)
try:
# Perform a search
# For more search options, refer to the Intelligence X API documentation:
# https://docs.intelx.io/api/#search-api-quick-start
search_result = intelx_api.search(query, search_type=0, maxresults=10, timeout=10)
print(f"Search results for '{query}':")
if search_result and search_result['records']:
for record in search_result['records']:
print(f" - Type: {record.get('type')}, Value: {record.get('value')}, Date: {record.get('date')}")
else:
print(" No records found.")
except Exception as e:
print(f"An error occurred: {e}")
# Your Intelligence X API Key
API_KEY = "YOUR_API_KEY"
# The term you want to search for
SEARCH_QUERY = "example.com"
if __name__ == "__main__":
search_intelx(API_KEY, SEARCH_QUERY)
This script initializes the Intelligence X API client with your API key and then performs a search for "example.com". It prints the type, value, and date of the first 10 records found. The search_type=0 parameter specifies a generic search across all available data types. For specific search types, such as email addresses or domains, consult the Intelligence X search API quick start documentation.
Common next steps
After successfully making your first request, consider these common next steps to further integrate and leverage Intelligence X:
- Explore Advanced Search Parameters: The Intelligence X API offers extensive parameters for refining searches, including specific data types (e.g., email, phone, domain), date ranges, and sorting options. Review the Intelligence X search API documentation to understand these capabilities.
- Implement Error Handling: Robust applications should include comprehensive error handling for API calls. The Intelligence X API will return specific HTTP status codes and error messages for issues such as invalid API keys, rate limits, or malformed requests.
- Manage Rate Limits: Be aware of the rate limits associated with your subscription plan. Implement retry logic with exponential backoff for rate-limited requests to ensure your application can recover gracefully.
- Integrate with Other Tools: Consider integrating Intelligence X data into existing security information and event management (SIEM) systems, threat intelligence platforms, or custom dashboards.
- Utilize Data Breach Collections: Beyond general OSINT searches, explore the dedicated endpoints for querying data breach collections to monitor for compromised credentials or leaked information relevant to your organization.
- Monitor Darknet Activity: For more advanced threat intelligence, investigate the API capabilities for monitoring darknet and underground forum activity.
- Secure API Key Management: Implement best practices for storing and managing API keys, such as using environment variables, secret management services, or dedicated configuration files, rather than hardcoding them directly into your application code.
Troubleshooting the first call
If your first API call to Intelligence X encounters issues, consider the following troubleshooting steps:
- Check API Key Validity: Ensure your API key is correct and has not expired. Double-check for typos or leading/trailing spaces when copying the key. Re-generate the key from your Intelligence X account dashboard if necessary.
- Verify Subscription Status: API access requires an active paid subscription. Confirm that your plan is current and includes API access by checking your Intelligence X account status. The free tier does not support API calls.
- Review Request Syntax: Compare your API request against the Intelligence X API reference documentation. Pay close attention to endpoint URLs, required parameters, and data formats (e.g., JSON structure).
- Inspect Error Messages: The API will return specific error messages and HTTP status codes (e.g., 401 Unauthorized, 403 Forbidden, 429 Too Many Requests, 500 Internal Server Error). These messages are crucial for diagnosing the problem. For example, a 401 status often indicates an invalid API key.
- Check Network Connectivity: Ensure your development environment has outbound network access to
api.intelx.io. Firewall rules or proxy settings might block the connection. - Consult SDK Documentation: If using an official Intelligence X SDK (Python, Go, etc.), review its specific documentation for common setup issues or examples. Ensure the SDK is installed correctly and up-to-date.
- Test with cURL: As an alternative to SDKs, try making a direct HTTP request using
cURLto isolate whether the issue is with your code or the API key/subscription. For example:
This example uses the WHOIS search endpoint for brevity, but the principle applies to other endpoints. Replacecurl -X GET "https://api.intelx.io/whois/search?term=example.com" \ -H "x-key: YOUR_API_KEY"YOUR_API_KEYwith your actual key. - Contact Support: If you've exhausted all troubleshooting steps, contact Intelligence X support for assistance. Provide them with details of your issue, including error messages, API key status, and the code snippet or cURL command you are using.