Skip to main content
POST
/
v1
/
search
Search Scans
curl --request POST \
  --url https://api.urldna.io/v1/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>"
}'
[
  {
    "id": "<string>",
    "submitted_url": "<string>",
    "domain": "<string>",
    "target_url": "<string>",
    "protocol": "<string>",
    "device": "DESKTOP",
    "user_agent": "<string>",
    "http_referer": "<string>",
    "nsfw": true,
    "scanned_from": "DEFAULT",
    "origin": "API",
    "width": 123,
    "height": 123,
    "private_scan": true,
    "status": "PENDING",
    "submitted_date": "2023-11-07T05:31:56Z",
    "submitter_tags": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Body

application/json
​
query
string
required

Search query or CQL string to filter scans.

Response

Search results retrieved successfully.

List of matching scans, sorted by submission date in descending order.

​
id
string

Unique, autogenerated identifier for the scan.

​
submitted_url
string

The URL provided by the user to be scanned.

​
domain
string

The domain of the submitted URL.

​
target_url
string

The final URL after any redirection (if applicable).

​
protocol
string

The protocol of the URL, such as HTTP or HTTPS.

​
device
enum<string>

The type of device selected for the scan, either 'DESKTOP' or 'MOBILE'.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

The user agent string associated with the device for simulating the browser environment.

​
http_referer
string

The HTTP Referer URL is the address of web page from wich a request for a resource originated.

​
nsfw
boolean

Indicates whether the content of the page contains Not Safe For Work (NSFW) material, such as nudity or adult content.

​
scanned_from
enum<string>

The country from which the scan was initiated. Available only for PREMIUM users.

Available options:
DEFAULT,
AU,
BE,
CA,
CH,
DE,
ES,
FR,
GB,
GR,
HU,
ID,
IT,
JP,
MX,
NL,
PT,
ZA,
TR,
US
​
origin
enum<string>

Indicates whether the scan was submitted via the API or by a user.

Available options:
API,
USER
​
width
number

The width of the viewport used during the scan in pixels.

​
height
number

The height of the viewport used during the scan in pixels.

​
private_scan
boolean

If true, the scan results are only accessible by the user who submitted the scan.

​
status
enum<string>

The current status of the scan. 'PENDING' and 'RUNNING' are intermediate states, while 'DONE' and 'ERROR' are final states.

Available options:
PENDING,
RUNNING,
DONE,
ERROR
​
submitted_date
string<date-time>

The date and time when the scan was submitted.

​
submitter_tags
string[]

A list of any tags associated with the scan, submitted by the user.

⌘I