Skip to content
/Data Dumps

urlscan.io APIs (1.0.0)

Introduction

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.

Download OpenAPI description
urlscan-openapi.json
urlscan-openapi.yaml
Overview
urlscan Support
support@urlscan.io
Languages
Servers
https://urlscan.io

Generic

API endpoints related to the platform or the user account.

Operations

Scanning

These APIs allow URLs to be scanned and the results of the scans to be retrieved.

Operations

Live Scanning

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.

Operations

Saved Searches

urlscan Pro - Saved Searches are rules that are executed inline against new incoming scans and hostnames.

Operations

Subscriptions

urlscan Pro - Subscriptions allow notifications for Saved Searches.

Operations

Hostnames

urlscan Pro - Historical information on hostnames and domains

Operations

Brands

urlscan Pro - Information about tracked brands

Operations

Files

urlscan Pro - Downloaded files

Operations

Incidents

urlscan Pro - Incidents track observables, like hostnames and domains, and automatically scan and alert on changes.

Operations

Channels

Operations

Data Dumps

Operations

List Data Dump Files

Request

urlscan Pro - List available data dump files for a specific time window, file type, and date.

Security
apikeyAuth
Path
timeWindowstringrequired

Time window of the data dump

Enum"days""hours""minutes"
fileTypestringrequired

Type of data dump file

Enum"api""search""screenshot""dom"
datestring(date)required

Date of the data dump in YYYYMMDD format

curl -i -X GET \
  'https://urlscan.io/api/v1/datadump/list/{timeWindow}/{fileType}/{date}' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
filesArray of objects
Response
application/json
{
  "files": [
    { … },
    { … }
  ]
}