API Endpoints
/
Generic
/
User Information

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

API Quotas

Request

API Endpoint to get available and used API quotas.

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

Responses

OK

Bodyapplication/json
sourcestringrequired

Source of the quota limits

limitsobjectrequired
limits.​privateobjectrequired
limits.​private.​dayobject(QuotaPeriod)required
limits.​private.​day.​limitintegerrequired

Maximum allowed usage for this period

limits.​private.​day.​usedintegerrequired

Amount of quota used in this period

limits.​private.​day.​remainingintegerrequired

Remaining quota for this period

limits.​private.​day.​percentnumberrequired

Percentage of quota used

limits.​private.​hourobject(QuotaPeriod)required
limits.​private.​hour.​limitintegerrequired

Maximum allowed usage for this period

limits.​private.​hour.​usedintegerrequired

Amount of quota used in this period

limits.​private.​hour.​remainingintegerrequired

Remaining quota for this period

limits.​private.​hour.​percentnumberrequired

Percentage of quota used

limits.​private.​minuteobject(QuotaPeriod)required
limits.​private.​minute.​limitintegerrequired

Maximum allowed usage for this period

limits.​private.​minute.​usedintegerrequired

Amount of quota used in this period

limits.​private.​minute.​remainingintegerrequired

Remaining quota for this period

limits.​private.​minute.​percentnumberrequired

Percentage of quota used

limits.​property name*anyadditional property
Response
application/json
{
  "source": "team",
  "limits": {
    "private": { … },
    "public": { … },
    "retrieve": { … },
    "search": { … },
    "unlisted": { … },
    "livescan": { … },
    "liveshot": { … },
    "maxRetentionPeriodDays": 90,
    "privateIncidentCreate": { … },
    "unlistedIncidentCreate": { … },
    "privateIncidentOpen": 100,
    "unlistedIncidentOpen": 200,
    "maxSearchRangeMonths": 6,
    "maxSearchResults": 10000,
    "products": [ … ],
    "features": [ … ],
    "queryableFields": [ … ],
    "queryVisibility": [ … ]
  }
}

User Information

Request

Get information about the current user or API key making the request.

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

Responses

Successful response

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

Incidents

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

Operations