Structure Search

Request

urlscan Pro - Get structurally similar results to a specific scan. See description for this propietary feature on urlscan Pro.

Security

apikeyAuth(Required scopes: readwrite)

Path

scanIdstringrequired

The original scan to compare to

Example:68e26c59-2eae-437b-aeb1-cf750fafe7d7

Query

qstring

Additional query filter

Example:q=page.domain:urlscan.io

sizeinteger

Maximum results per call

Example:size=10

search_afterstring

Parameter to iterate over older results

curl -i -X GET \
  'https://urlscan.io/api/v1/pro/result/68e26c59-2eae-437b-aeb1-cf750fafe7d7/similar/?q=page.domain%3Aurlscan.io&size=10&search_after=string' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

resultsArray of objects

Array of search results. Scans by default; other datasources return their own document types.

totalinteger

Total number of results with an exact count up to 10,000 results.

tookinteger

Search request time in milliseconds.

has_moreboolean

True if there are more than 10,000 results.

search_date_limit_daysinteger

Maximum number of days the search will go back. Only present if the search history is limited, which applies to unauthenticated requests and free users.

Response

{
  "results": [
    { … },
    { … }
  ],
  "total": 7684,
  "took": 72,
  "has_more": false
}