API Endpoints
/
Brands

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

Available Brands

Request

API Endpoint to get a list of brands that are tracked as part of urlscan's brand and phishing detection.

Security
apikeyAuth
curl -i -X GET \
  http://urlscan.io/api/v1/pro/availableBrands \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
kitsArray of objects
Response
application/json
{
  "kits": [
    { … }
  ]
}

Brands

Request

Get the list of brands that we are able to detect phishing pages, the total number of detected pages and the latest hit for each brand. This is slower than the availableBrands endpoint.

Security
apikeyAuth
curl -i -X GET \
  http://urlscan.io/api/v1/pro/brands \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Files

urlscan Pro - Downloaded files

Operations

Incidents

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

Operations