API|v2.0 Documentation

API Documentation

Access our intelligence platform programmatically through our REST API. Our API enables you to integrate powerful intelligence gathering capabilities directly into your applications.

Fast Integration

Quick and easy integration with detailed examples

Secure by Default

Enterprise-grade security with API key authentication

Real-time Data

Access live intelligence data with millisecond latency

Authentication

All API requests require authentication using an API key:

API Key Authentication

Add your API key to the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

POST/api/v2/search

Search across multiple intelligence services with a single request. Supports various search types including email, phone, username, and more.

Request Body

{
  "service": "dblookup",
  "params": {
    "type": "email",
    "query": "[email protected]",
    "include_details": true
  }
}

Response

{
  "success": true,
  "data": {
    "found": true,
    "details": {
      "email": "[email protected]",
      "first_seen": "2023-01-15T00:00:00Z",
      "last_seen": "2024-02-20T00:00:00Z",
      "breach_count": 2,
      "sources": ["database1", "database2"]
    }
  },
  "version": "v2",
  "timestamp": "2024-04-10T03:34:00.000Z"
}
GET/api/v2/identity/{id}

Retrieve detailed identity information for a specific identifier. Returns comprehensive data from multiple sources.

Response

{
  "success": true,
  "data": {
    "id": "123456",
    "identity": {
      "username": "johndoe",
      "email": "[email protected]",
      "first_seen": "2023-05-10T00:00:00Z",
      "last_active": "2024-03-15T00:00:00Z",
      "associated_ips": ["192.168.1.1", "10.0.0.1"],
      "platforms": ["discord", "github"]
    }
  },
  "version": "v2",
  "timestamp": "2024-04-10T03:34:00.000Z"
}
POST/api/v2/batch/search

Perform bulk searches across multiple services. Ideal for processing large datasets efficiently.

Request Body

{
  "service": "multi",
  "queries": [
    {
      "type": "email",
      "query": "[email protected]"
    },
    {
      "type": "username",
      "query": "user2"
    }
  ],
  "options": {
    "concurrent": true,
    "timeout": 30
  }
}

Response

{
  "success": true,
  "data": {
    "results": [
      {
        "query": "[email protected]",
        "found": true,
        "data": { /* result data */ }
      },
      {
        "query": "user2",
        "found": false,
        "error": "No matches found"
      }
    ],
    "stats": {
      "total": 2,
      "successful": 1,
      "failed": 1
    }
  },
  "version": "v2",
  "timestamp": "2024-04-10T03:34:00.000Z"
}

Rate Limiting

API requests are rate limited based on your subscription plan. The current limits are:

Basic

100 requests per minute

Professional

500 requests per minute

Enterprise

Custom limits available

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of requests:

Success Codes

200Success
201Created
204No Content

Error Codes

400Bad Request
401Unauthorized
429Too Many Requests

Error Response Format

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_REQUIRED",
    "message": "Valid API key required",
    "details": {
      "hint": "Add your API key to the Authorization header"
    }
  },
  "version": "v2",
  "timestamp": "2024-04-10T03:34:00.000Z"
}