Create a new OSINT search

POST

https://api.sherlockeye.io/v1/searches

Searches

Last modified:2026-01-28 20:51:30

Creates a new background search job for a given identifier (for example, an email,
domain or username). The search is processed asynchronously.

Use GET /v1/searches/{searchId} to poll for status and results, and
GET /v1/searches/{searchId}/summary to obtain an AI‑generated summary.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Email searchDomain search

{
    "type": "email",
    "value": "someone@example.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Email searchDomain search

curl --location --request POST 'https://api.sherlockeye.io/v1/searches' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "email",
    "value": "someone@example.com"
}'

Responses

🟢201

application/json

Search job successfully created.

Body

Example

{
    "success": true,
    "data": {
        "searchId": "f6f3b720-4f3a-4dcf-9d0e-6e5efc46f8c9",
        "type": "email",
        "value": "someone@example.com",
        "status": "processing",
        "createdAt": "2025-01-01T12:00:00.000Z"
    }
}

🟠400

🟠401

🟠403

🟠422

🟠429

🔴500

Modified at 2026-01-28 20:51:30

Get token balance for the authenticated user

Get search details and results