urlscan Support
API endpoints for urlscan.io and urlscan Pro. Most of these API endpoints require authentication.
The fastest way to start working with our APIs is by using one of the many existing commercial or open-source integrations.
https://urlscan.io/
urlscan Pro - Live Scanning allows users to scan websites from different geographical locations and using different device settings.
See additional info about this proprietary feature on urlscan Pro.
https://urlscan.io/api/v1/user/searches/
curl -i -X GET \
https://urlscan.io/api/v1/user/searches/ \
-H 'api-key: YOUR_API_KEY_HERE'Successful response
{ "searches": [ { … } ] }
Determine whether other users on the team or on urlscan Pro can see the search.
TLP (Traffic Light Protocol) indicator for other users on the urlscan Pro platform
https://urlscan.io/api/v1/user/searches/
curl -i -X POST \
https://urlscan.io/api/v1/user/searches/ \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-d '{
"search": {
"_id": "{{searchId}}",
"datasource": "scans",
"query": "page.domain:postman.co",
"name": "Testsearch",
"description": "Saved Search for testing purposes",
"longDescription": "This Saved Search was created for testing purposes by Postman",
"tlp": "red",
"userTags": [
"private.privatetag"
],
"permissions": [
"team:read",
"team:write"
]
}
}'{ "uuid": "10dae531-a98a-42fc-8c6f-cb8610ec0c10" }
Determine whether other users on the team or on urlscan Pro can see the search.
TLP (Traffic Light Protocol) indicator for other users on the urlscan Pro platform
https://urlscan.io/api/v1/user/searches/{searchId}/
curl -i -X PUT \
'https://urlscan.io/api/v1/user/searches/{{searchId}}/' \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-d '{
"search": {
"_id": "{{searchId}}",
"datasource": "scans",
"query": "page.domain:postman.co",
"name": "Testsearch",
"description": "Saved Search for testing purposes",
"longDescription": "This Saved Search was created for testing purposes by Postman",
"tlp": "red",
"userTags": [
"private.privatetag"
],
"permissions": [
"team:read",
"team:write"
]
}
}'{ "uuid": "10dae531-a98a-42fc-8c6f-cb8610ec0c10" }
https://urlscan.io/api/v1/user/searches/{searchId}/
curl -i -X DELETE \
'https://urlscan.io/api/v1/user/searches/{{searchId}}/' \
-H 'api-key: YOUR_API_KEY_HERE'{ "uuid": "10dae531-a98a-42fc-8c6f-cb8610ec0c10" }
https://urlscan.io/api/v1/user/searches/{searchId}/results/
curl -i -X GET \
'https://urlscan.io/api/v1/user/searches/{{searchId}}/results/' \
-H 'api-key: YOUR_API_KEY_HERE'