{ "openapi": "3.0.1", "info": { "title": "Sherlock Username Recon", "description": "Scan 400+ social networks for any username in minutes. Returns confirmed profile URLs with platform categories and metadata. Built for OSINT, digital footprint mapping, brand monitoring, and background research.", "version": "0.1", "x-build-id": "ed1bJZGxufVcJkkzH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacach~userrecon/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacach-userrecon", "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/datacach~userrecon/runs": { "post": { "operationId": "runs-sync-datacach-userrecon", "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/datacach~userrecon/run-sync": { "post": { "operationId": "run-sync-datacach-userrecon", "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", "type": "array", "description": "One or more usernames to search across 400+ social networks simultaneously. Each entry must be a plain username string — do not include the @ symbol, profile URLs, or any extra characters (e.g. use 'johndoe', not '@johndoe' or 'https://twitter.com/johndoe'). Multiple usernames are processed concurrently. Free accounts: max 1 username per run. Paid accounts: max 10 usernames per run.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy to route all HTTP requests through. Recommended for high-volume runs or when target platforms block cloud datacenter IPs. Supports Apify Proxy (residential and datacenter) or custom proxy URLs (HTTP/SOCKS5). Leave empty to use the built-in fallback proxy.", "default": { "useApifyProxy": false } }, "timeout": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 300, "type": "integer", "description": "Maximum seconds to wait for a response from each site before skipping it. Use 15–30 for faster runs with minimal accuracy loss. Use 60–120 for thorough scans where missing results is unacceptable. Default is 60 seconds.", "default": 60 }, "includeNsfw": { "title": "Include NSFW Sites", "type": "boolean", "description": "Whether to include adult and NSFW platforms in the username search. Set to true for comprehensive OSINT and digital footprint investigations. Set to false (default) for HR screening, brand monitoring, compliance, and general-audience use cases.", "default": false }, "siteList": { "title": "Limit to Specific Sites", "type": "array", "description": "Restrict the search to a specific subset of platforms instead of scanning all 400+. Useful when you only care about a handful of networks and want faster, cheaper runs. Each entry can be a full URL ('https://github.com'), a bare domain ('github.com'), or the Sherlock site name ('GitHub') — all three formats are equivalent and resolved automatically. Leave empty to search all available sites.", "default": [], "items": { "type": "string" } } } }, "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 } } }, "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 } } } } } } } } } }