> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# URLScan

> Reference for the Tracecat URLScan integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Get result

Action ID: `tools.urlscan.get_result`

Get a urlscan result. Calls GET /api/v1/result/\{uuid}/ directly.

Reference: [https://docs.urlscan.io/apis/urlscan-openapi/scanning/getresult](https://docs.urlscan.io/apis/urlscan-openapi/scanning/getresult)

### Secrets

Required secrets:

* `urlscan`: required values `URLSCAN_API_KEY`.

### Input fields

<ParamField path="uuid" type="string" required>
  urlscan scan UUID.
</ParamField>

<ParamField path="base_url" type="string | null">
  urlscan base URL.

  Default: `null`.
</ParamField>

## Get screenshot

Action ID: `tools.urlscan.get_screenshot`

Get a urlscan PNG screenshot. Calls GET /screenshots/\{uuid}.png directly.

Reference: [https://docs.urlscan.io/apis/urlscan-openapi/scanning/getscreenshot](https://docs.urlscan.io/apis/urlscan-openapi/scanning/getscreenshot)

### Secrets

Required secrets:

* `urlscan`: required values `URLSCAN_API_KEY`.

### Input fields

<ParamField path="uuid" type="string" required>
  urlscan scan UUID.
</ParamField>

<ParamField path="base_url" type="string | null">
  urlscan base URL.

  Default: `null`.
</ParamField>

## Lookup URL

Action ID: `tools.urlscan.lookup_url`

Lookup a URL using URLScan.

Reference: [https://urlscan.io/docs/result/](https://urlscan.io/docs/result/)

### Secrets

Required secrets:

* `urlscan`: required values `URLSCAN_API_KEY`.

### Input fields

<ParamField path="url" type="string" required>
  URL to lookup.
</ParamField>

<ParamField path="visibility" type="string">
  Visibility of the scan.

  Default: `"private"`.
</ParamField>

## Search scans

Action ID: `tools.urlscan.search_scans`

Search urlscan scans. Calls GET /api/v1/search/ directly.

Reference: [https://docs.urlscan.io/apis/urlscan-openapi/search/searchdatasource](https://docs.urlscan.io/apis/urlscan-openapi/search/searchdatasource)

### Secrets

Required secrets:

* `urlscan`: required values `URLSCAN_API_KEY`.

### Input fields

<ParamField path="base_url" type="string | null">
  urlscan base URL.

  Default: `null`.
</ParamField>

<ParamField path="datasource" type="string | null">
  Datasources to search - scans (urlscan.io), hostnames, incidents, notifications, certificates (urlscan Pro).

  Default: `null`.
</ParamField>

<ParamField path="query" type="string">
  Search Query (Elasticsearch Query String). Maps to q.

  Default: `"*"`.
</ParamField>

<ParamField path="search_after" type="string | null">
  For retrieving the next batch of results, send the value of the sort attribute of the last (oldest) result you received (comma-separated) from the previous call.

  Default: `null`.
</ParamField>

<ParamField path="size" type="integer | null">
  Number of results to return.

  Default: `null`.
</ParamField>