Powered by Volta Payment
Powered by Volta Payment
Everything you need to integrate LookEyes API
Welcome to the LookEyes API documentation. This guide will help you get started with our powerful data search API.
Keep your API key secret! Anyone with your key can access the API and consume your quota.
All API requests must include your API key in the request headers:
x-api-key: YOUR_API_KEY_HERE
curl -X GET "https://lookeyes.st/search?value=john.doe@example.com&type=EMAIL" \
-H "x-api-key: YOUR_API_KEY_HERE"
Search for data with optional type filtering and relation depth.
| Parameter | Type | Required | Description |
|---|---|---|---|
| value | string | Yes | The search value (email, phone, name, etc.) |
| type | string | No | Data type filter (EMAIL, PHONE, NAME, ADDRESS, etc.) |
| depth | number | No | Relation search depth (default: 2) |
| limit | number | No | Maximum results (default: 50) |
GET /search?value=john.doe@example.com&type=EMAIL&limit=20
{
"results": [
{
"email": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"phone": "+1234567890",
"address": "123 Main St",
"source": "database_name"
}
],
"total": 1,
"page": 1
}
Fuzzy search with pagination for autocomplete and partial matches.
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Partial search term |
| type | string | No | Data type filter |
| source | string | No | Filter by data source ID |
| limit | number | No | Results per page (default: 20) |
| page | number | No | Page number (default: 1) |
GET /search/suggest?query=john&type=NAME&limit=10&page=1
Get database statistics and record counts.
{
"totalRecords": 125000000,
"sources": 15,
"lastUpdated": "2025-01-15T12:00:00Z"
}
Get information about your API key.
{
"role": "tempuser",
"createdAt": "2025-01-01T10:00:00Z",
"expiresAt": "2026-01-01T10:00:00Z",
"requestCount": 1250,
"lastUsedAt": "2025-01-15T14:30:00Z",
"isActive": true
}
Get available data types for filtering searches.
{
"availableTypes": ["EMAIL", "PHONE", "NAME", "ADDRESS", "IP", "USERNAME", ...]
}
Check API status (no authentication required).
{
"status": "ok",
"timestamp": "2025-01-15T10:30:00Z"
}
| Plan | Rate Limit | Burst Limit |
|---|---|---|
| Test (Monthly) | 100 req/min | 150 req/min |
| Test (Yearly) | 100 req/min | 150 req/min |
Each response includes headers showing your current rate limit status:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642252800
| Code | Status | Description |
|---|---|---|
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key expired or quota exceeded |
| 404 | Not Found | No results found |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error, please retry |
{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or expired"
}
}
const axios = require('axios');
async function searchAPI(value, type = 'EMAIL') {
try {
const response = await axios.get('https://lookeyes.st/search', {
params: { value, type, limit: 50 },
headers: { 'x-api-key': process.env.LOOKEYES_API_KEY }
});
console.log(response.data);
} catch (error) {
console.error('Error:', error.response?.data);
}
}
searchAPI('john.doe@example.com', 'EMAIL');
import requests
import os
def search_api(value, data_type='EMAIL'):
url = 'https://lookeyes.st/search'
headers = { 'x-api-key': os.getenv('LOOKEYES_API_KEY') }
params = { 'value': value, 'type': data_type, 'limit': 50 }
response = requests.get(url, params=params, headers=headers)
return response.json()
result = search_api('john.doe@example.com', 'EMAIL')
print(result)
$value,
'type' => $type,
'limit' => 50
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['x-api-key: ' . $apiKey]);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
print_r($result);
If you need assistance or have questions about the API: