API Documentation

Everything you need to integrate LookEyes API

🚀 Getting Started

Welcome to the LookEyes API documentation. This guide will help you get started with our powerful data search API.

Quick Start

  1. Purchase an API key
    Visit the homepage and select a plan. Complete the payment to receive your API key.
  2. Store your API key securely
    Save your API key in a secure location. Never expose it in client-side code or public repositories.
  3. Make your first request
    Use your API key in the x-api-key header to authenticate your requests.
⚠️ Important

Keep your API key secret! Anyone with your key can access the API and consume your quota.

🔐 Authentication

All API requests must include your API key in the request headers:

x-api-key: YOUR_API_KEY_HERE

Example Request

curl -X POST https://api.lookeyes.com/api/search \ -H "x-api-key: YOUR_API_KEY_HERE" \ -H "Content-Type: application/json" \ -d '{"query": "john.doe@example.com"}'

📡 API Endpoints

Search Endpoint

POST /api/search

Search for data using exact or fuzzy matching.

Request Body

Parameter Type Required Description
query string Yes Search term (email, name, phone, etc.)
searchType string No "exact" or "fuzzy" (default: "exact")

Example Request

{ "query": "john.doe@example.com", "searchType": "exact" }

Example Response (Success)

{ "success": true, "data": { "results": [ { "email": "john.doe@example.com", "firstName": "John", "lastName": "Doe", "phone": "+1234567890", "address": "123 Main St" } ], "count": 1 } }

Stats Endpoint

GET /api/search/stats

Get API usage statistics for your account.

Example Response

{ "success": true, "data": { "totalRequests": 1250, "remainingRequests": 8750, "plan": "yearly", "expiresAt": "2026-01-15T12:00:00Z" } }

Health Check

GET /api/health

Check API status (no authentication required).

{ "status": "ok", "timestamp": "2025-01-15T10:30:00Z" }

⚡ Rate Limits

Plan Rate Limit Burst Limit
Test (Monthly) 100 req/min 150 req/min
Test (Yearly) 100 req/min 150 req/min
⚠️ Rate Limit Headers

Each response includes headers showing your current rate limit status:

X-RateLimit-Limit: 100 X-RateLimit-Remaining: 95 X-RateLimit-Reset: 1642252800

❌ Error Codes

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

Error Response Format

{ "success": false, "error": { "code": "INVALID_API_KEY", "message": "The provided API key is invalid or expired" } }

💡 Best Practices

  • ✅ Always use HTTPS for API requests
  • ✅ Store API keys securely (use environment variables)
  • ✅ Implement proper error handling in your application
  • ✅ Cache responses when appropriate to reduce API calls
  • ✅ Monitor your rate limits to avoid throttling
  • ✅ Use exact search when possible for better performance
  • ❌ Never expose API keys in client-side code
  • ❌ Don't hardcode API keys in your source code
  • ❌ Avoid making unnecessary duplicate requests

🔧 Code Examples

JavaScript / Node.js

const axios = require('axios'); async function searchAPI(query) { try { const response = await axios.post( 'https://api.lookeyes.com/api/search', { query, searchType: 'exact' }, { headers: { 'x-api-key': process.env.LOOKEYES_API_KEY, 'Content-Type': 'application/json' } } ); console.log(response.data); } catch (error) { console.error('Error:', error.response.data); } } searchAPI('john.doe@example.com');

Python

import requests import os def search_api(query): url = 'https://api.lookeyes.com/api/search' headers = { 'x-api-key': os.getenv('LOOKEYES_API_KEY'), 'Content-Type': 'application/json' } data = { 'query': query, 'searchType': 'exact' } response = requests.post(url, json=data, headers=headers) return response.json() result = search_api('john.doe@example.com') print(result)

PHP

$query, 'searchType' => 'exact' ])); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); print_r($result);

❓ Need Help?

If you need assistance or have questions about the API:

💬 Join our Discord

Get help from our community and support team

Get Support →