API Endpoints
/
Files
/
Download a file

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.

External Resources

Download OpenAPI description
urlscan-openapi.json
urlscan-openapi.yaml
Overview
urlscan Support

support@urlscan.io

Languages
Servers

http://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

Search

The Search API allows users to search for historically website scans, hostnames, domains, TLS certificates and incidents.

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

Download a file

Request

urlscan Pro - Download a file by SHA256 hash. For the ZIP files delivered by this endpoint, the default encryption password is urlscan! - including the trailing exclamation mark. The ZIP file contains a single file named after the SHA256 of the requested file.

Security
apikeyAuth
Path
fileHashstringrequired

SHA256 hash of file

Query
passwordstring

The password to use to encrypt the ZIP file. Using a password is mandatory, the default password is urlscan!

Default "urlscan!"
filenamestring

Specify the name of the ZIP file that should be downloaded. This does not change the name of files within the ZIP archive. The default filename is $fileHash.zip

Default "$fileHash.zip"
curl -i -X GET \
  'http://urlscan.io/downloads/{fileHash}?filename=%24fileHash.zip&password=urlscan!' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/zip
string(binary)

Incidents

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

Operations