{ "openapi": "3.0.1", "info": { "title": "Sherlock Username Search — OSINT on 480+ Sites", "description": "Search a username across Sherlock's catalog of 480+ sites in social, developer, gaming, forum, media and business categories, with optional NSFW sites. Returns public profile URLs with claimed, available or unknown status, per username or as one flat row per matched site. Flat price per username.", "version": "0.8", "x-build-id": "fAmbWgruNaYH2Ztmf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~username-osint-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-username-osint-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/khadinakbar~username-osint-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-username-osint-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/khadinakbar~username-osint-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-username-osint-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "usernames" ], "properties": { "usernames": { "title": "Usernames to scan", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "List of usernames to look up across Sherlock's 481-site catalog. Each username triggers one sequential scan with parallel site requests and one billable event. Plain handles are accepted with an optional leading @; URLs, email addresses, spaces, and path/query characters are rejected. Example: ['khadinakbar', '@gvanrossum'].", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "includeAvailable": { "title": "Include AVAILABLE results", "type": "boolean", "description": "If true, the output includes platforms where the username is NOT registered (status: AVAILABLE) in addition to CLAIMED ones. WAF and UNKNOWN rows remain marked uncertain rather than being treated as available. Defaults to false for a compact OSINT result. Set to true for username-availability checks before registering on multiple platforms.", "default": false }, "includeNSFW": { "title": "Include adult/NSFW sites", "type": "boolean", "description": "If true, adds the 19 adult-oriented platforms in the Sherlock site list to the 462 non-NSFW default set. Defaults to false. Set to true only for compliance, brand-protection, or fraud-investigation workflows where adult-site presence is part of the investigation.", "default": false }, "categories": { "title": "Site categories to scan (empty = all)", "uniqueItems": true, "type": "array", "description": "Restrict the scan to specific categories of sites to reduce runtime and surface only relevant platforms. Empty array (default) scans all 462 non-NSFW entries, or all 481 entries when includeNSFW is true. The example input uses ['dev'] so automated health checks finish quickly.", "items": { "type": "string", "enum": [ "social", "dev", "gaming", "forum", "media", "business", "other" ] }, "default": [] }, "concurrency": { "title": "Concurrent requests", "minimum": 5, "maximum": 100, "type": "integer", "description": "Number of parallel HTTP requests across the site list. Higher = faster but more memory. Defaults to 40 (good for 512MB actor). Increase to 80 only if you bump the actor memory; reduce to 20 on slow networks. NOT the number of usernames in parallel — each username is processed sequentially.", "default": 40 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum seconds to wait for any single site response before recording an uncertain result. Defaults to 15. The example input uses 8 seconds so automated health checks finish quickly. This is per request, not per username.", "default": 15 }, "outputMode": { "title": "Output mode", "enum": [ "per-username", "per-hit" ], "type": "string", "description": "'per-username' (default) returns one dataset row per username with a nested platforms[] list. 'per-hit' returns one flat row per matched site with username, site, category, url, status and detection method, which is easier to open as CSV. Billing is identical: one username-scanned event per username in both modes; a username with no matches produces no per-hit row but is still one scanned username.", "default": "per-username" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Defaults to Apify residential proxies for the best success rate against WAF-protected sites. Override only if you have specific proxy needs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }