Package Information
Released: 5 mo ago
Downloads: 2 weekly / 132 monthly
Latest Version: 0.1.0
Author: Sherlock n8n Integrations
Available Nodes
Documentation generating…
Documentation
n8n Sherlock Username Hunter
This community node brings the functionality of the Sherlock project to n8n. It
lets you search for claimed usernames across hundreds of social networks directly from your workflows, using the upstream
Sherlock manifest.
Features
- Pulls the latest Sherlock target manifest (or a custom JSON manifest) at runtime.
- Probes sites in parallel with configurable concurrency and request timeouts.
- Matches Sherlock’s detection logic (
message,status_code, andresponse_url) including WAF fingerprinting and illegal
username checks. - Supports placeholder expansion (
{?}->_,-,.) to test multiple username variations automatically. - Optional inclusion of NSFW targets and the upstream false-positive exclusion list.
- Returns detailed per-site results with HTTP status, probe URL, response time, and optional response snippets for debugging.
Node parameters
| Parameter | Description |
|---|---|
| Username | Username to test. When Expand {?} Placeholder is enabled, the node expands user{?} into user_, user-, user.. |
| Expand {?} Placeholder | Mirrors Sherlock’s CLI behaviour for pattern expansion. |
| Include NSFW Sites | Include targets flagged as not safe for work. |
| Site Selection | Choose all sites, only specific sites, or exclude selected sites. |
| Honor Upstream Exclusions | Skip sites that Sherlock flags as unreliable. |
| Manifest Source | Use the official Sherlock manifest or provide a custom JSON URL. |
| Request Timeout | Seconds to wait for each HTTP request before aborting. |
| Concurrent Requests | Number of sites probed in parallel (default: 10). |
| Results Filter | Return all results, only claimed, only available, or only problematic statuses. |
| Include Response Snippet | Attach the first N characters of each HTTP response body for troubleshooting. |
Output structure
Each input item yields one (or multiple, when expanding placeholders) output items with the following structure:
{
"username": "example",
"baseUsername": "example",
"manifestUrl": "https://…/data.json",
"totalSitesQueried": 500,
"summary": {
"total": 500,
"claimed": 3,
"available": 480,
"illegal": 10,
"waf": 2,
"unknown": 5
},
"results": [
{
"site": "Twitter",
"url": "https://twitter.com/example",
"probeUrl": "https://twitter.com/example",
"status": "Claimed",
"httpStatus": 200,
"responseTimeMs": 523,
"detectionMethod": "status_code"
},
{
"site": "GitHub",
"status": "Available",
"httpStatus": 404,
"responseTimeMs": 317,
"context": null,
"detectionMethod": "status_code"
}
],
"warnings": [
"Could not load upstream exclusion list. Continuing without it."
]
}
Usage tips
- Add the Sherlock node to your workflow, set the username, and execute. The node will fetch the manifest on the first run
and cache it for subsequent items within the same process. - Increase the concurrency cautiously if you run into rate limiting. Decrease it when working behind strict firewalls or
proxies. - When debugging false positives/negatives, enable the response snippet option to capture the HTML returned by the site.
- For deterministic behaviour, host your own manifest JSON and point the node to it via Manifest Source → Custom Manifest URL.
Development
npm install
npm run lint
npm run build
The tests run eslint with the community node ruleset. Use npm run build to compile TypeScript sources before packaging or
linking the node into a local n8n instance.