API Endpoints
/
Hostnames

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

Hostname History

Request

Get the historical observations for a specific hostname in the "Hostnames" data source.

Security
apikeyAuth
Path
hostnamestringrequired

The hostname to query

Example: urlscan.io
Query
limitinteger

Return at most this many results. Minimum 10 Maximum 10000 Default 1000

Default 1000
pageStatestring

Continue return additional (older) results starting from this pageState response value from the previous API call.

curl -i -X GET \
  'http://urlscan.io/api/v1/hostname/urlscan.io?limit=1000&pageState=string' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
pageStatestring

If the pageState field is set then there are additional results available. Repeat the API call with the pageState value to get the next batch of results.

resultsArray of objects
Response
application/json
{
  "example": {
    "results": [ … ],
    "pageState": "xxx"
  }
}

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