Skip to main content
POST
/
v1
/
scan
Create scan
curl --request POST \
  --url https://api.urldna.io/v1/scan \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "submitted_url": "<string>",
  "device": "DESKTOP",
  "user_agent": "<string>",
  "http_referer": "<string>",
  "width": 123,
  "height": 123,
  "waiting_time": 5,
  "scanned_from": "DEFAULT",
  "private_scan": false,
  "submitter_tags": [
    "<string>"
  ],
  "origin": "API"
}
'
import requests

url = "https://api.urldna.io/v1/scan"

payload = {
"submitted_url": "<string>",
"device": "DESKTOP",
"user_agent": "<string>",
"http_referer": "<string>",
"width": 123,
"height": 123,
"waiting_time": 5,
"scanned_from": "DEFAULT",
"private_scan": False,
"submitter_tags": ["<string>"],
"origin": "API"
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
submitted_url: '<string>',
device: 'DESKTOP',
user_agent: '<string>',
http_referer: '<string>',
width: 123,
height: 123,
waiting_time: 5,
scanned_from: 'DEFAULT',
private_scan: false,
submitter_tags: ['<string>'],
origin: 'API'
})
};

fetch('https://api.urldna.io/v1/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.urldna.io/v1/scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'submitted_url' => '<string>',
'device' => 'DESKTOP',
'user_agent' => '<string>',
'http_referer' => '<string>',
'width' => 123,
'height' => 123,
'waiting_time' => 5,
'scanned_from' => 'DEFAULT',
'private_scan' => false,
'submitter_tags' => [
'<string>'
],
'origin' => 'API'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.urldna.io/v1/scan"

payload := strings.NewReader("{\n \"submitted_url\": \"<string>\",\n \"device\": \"DESKTOP\",\n \"user_agent\": \"<string>\",\n \"http_referer\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"waiting_time\": 5,\n \"scanned_from\": \"DEFAULT\",\n \"private_scan\": false,\n \"submitter_tags\": [\n \"<string>\"\n ],\n \"origin\": \"API\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.urldna.io/v1/scan")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"submitted_url\": \"<string>\",\n \"device\": \"DESKTOP\",\n \"user_agent\": \"<string>\",\n \"http_referer\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"waiting_time\": 5,\n \"scanned_from\": \"DEFAULT\",\n \"private_scan\": false,\n \"submitter_tags\": [\n \"<string>\"\n ],\n \"origin\": \"API\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.urldna.io/v1/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"submitted_url\": \"<string>\",\n \"device\": \"DESKTOP\",\n \"user_agent\": \"<string>\",\n \"http_referer\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"waiting_time\": 5,\n \"scanned_from\": \"DEFAULT\",\n \"private_scan\": false,\n \"submitter_tags\": [\n \"<string>\"\n ],\n \"origin\": \"API\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "submitted_url": "<string>",
  "user_agent": "<string>",
  "scanned_from": "<string>",
  "width": 123,
  "height": 123,
  "private_scan": true,
  "submitted_date": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "target_url": "<string>",
  "protocol": "<string>",
  "http_referer": "<string>",
  "nsfw": false,
  "submitter_tags": [
    "<string>"
  ],
  "error_code": "<string>"
}
{
"detail": "Error description message"
}
{
"detail": "Error description message"
}
{
"detail": "Error description message"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
{
"detail": "Error description message"
}
{
"detail": "Error description message"
}

Headers

authorization
string
required

Body

application/json
submitted_url
string
required
device
enum<string>
default:DESKTOP
Available options:
DESKTOP,
MOBILE
user_agent
string | null
http_referer
string | null
width
integer | null
height
integer | null
waiting_time
integer
default:5
Required range: 3 <= x <= 15
scanned_from
string
default:DEFAULT
private_scan
boolean
default:false
submitter_tags
string[]
origin
enum<string>
default:API
Available options:
USER,
API,
TELEGRAM

Response

Successful Response

id
string
required

Unique auto-generated scan identifier.

submitted_url
string
required

Original URL submitted for scanning.

device
enum<string>
required

Device type used for the scan simulation (DESKTOP or MOBILE).

Available options:
DESKTOP,
MOBILE
user_agent
string | null
required

User agent string used to simulate the browser environment.

scanned_from
string
required

Country code from which the scan was initiated. Available for PREMIUM users only.

origin
enum<string>
required

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

Available options:
USER,
API,
TELEGRAM
width
integer
required

Viewport width in pixels used during the scan.

height
integer
required

Viewport height in pixels used during the scan.

private_scan
boolean
required

When true, scan results are only accessible to the submitting user.

status
enum<string>
required

Current scan status. PENDING and RUNNING are transient states; DONE and ERROR are terminal states.

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

ISO 8601 timestamp when the scan was submitted.

domain
string | null

Extracted domain from the submitted URL.

target_url
string | null

Final destination URL after following all redirects.

protocol
string | null

Protocol used (HTTP or HTTPS).

http_referer
string | null

HTTP Referer header value indicating the originating page for the request.

nsfw
boolean | null
default:false

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

submitter_tags
string[] | null

User-defined tags for organizing and categorizing scans.

error_code
string | null

Error code when scan status is ERROR, indicating the reason for failure.