.actor/README.md
This Actor wraps the Sherlock Project to provide serverless username reconnaissance across social networks in the cloud. It helps you find usernames across multiple social media platforms without installing and running the tool locally.
Actors are serverless microservices running on the Apify Platform. They are based on the Actor SDK and can be found in the Apify Store. Learn more about Actors in the Apify Whitepaper.
apify call YOUR_USERNAME/sherlock --input='{
"usernames": ["johndoe", "janedoe"]
}'
curl --request POST \
--url "https://api.apify.com/v2/acts/YOUR_USERNAME~sherlock/run" \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{
"usernames": ["johndoe", "janedoe"],
}
}'
The Actor accepts a JSON schema with the following structure:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
usernames | array | Yes | - | List of usernames to search for |
usernames[] | string | Yes | "json" | Username to search for |
{
"usernames": ["techuser", "designuser"],
}
The Actor provides three types of outputs:
| Field | Type | Required | Description |
|---|---|---|---|
username | string | Yes | Username the search was conducted for |
links | array | Yes | Array with found links to the social media |
links[] | string | No | URL to the account |
{
"username": "johndoe",
"links": [
"https://github.com/johndoe"
]
}
For more help, check the Sherlock Project documentation or raise an issue in the Actor's repository.