Discover the URLs on a site - Truscan

POST

/

api

/

crawl

/

map

Discover the URLs on a site

curl --request POST \
  --url https://api.truscan.co/api/crawl/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "limit": 5000,
  "search": "docs",
  "subdomains": false,
  "sitemap_only": false
}
'

import requests

url = "https://api.truscan.co/api/crawl/map"

payload = {
    "url": "https://example.com",
    "limit": 5000,
    "search": "docs",
    "subdomains": False,
    "sitemap_only": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com',
    limit: 5000,
    search: 'docs',
    subdomains: false,
    sitemap_only: false
  })
};

fetch('https://api.truscan.co/api/crawl/map', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.truscan.co/api/crawl/map"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com\",\n  \"limit\": 5000,\n  \"search\": \"docs\",\n  \"subdomains\": false,\n  \"sitemap_only\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "success": true,
  "message": "<string>",
  "result": {
    "url": "<string>",
    "urls": [
      "<string>"
    ],
    "total": 123,
    "sources": {
      "sitemap": 123,
      "links": 123
    },
    "truncated": true
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An API key, sent as Authorization: Bearer enc_…. A dashboard session cookie works on the same route.

Body

application/json

url

string

required

The site to map. A bare hostname is accepted and assumed to be https.

Example:

"https://example.com"

limit

integer

default:5000

How many URLs to return.

Required range: 1 <= x <= 5000

search

string

Keep only URLs containing this text, matched case-insensitively against the whole URL. This is what makes a map of a ten thousand page site useful rather than merely large.

Example:

"docs"

subdomains

boolean

default:false

Widen the site from one host to its subdomains, so mapping example.com also lists docs.example.com.

sitemap_only

boolean

default:false

Read the sitemap and stop, skipping link discovery. Faster, kinder to the site, and complete for anyone who publishes an accurate sitemap.

Response

The URLs found, and where they came from

success

boolean

message

string

result

object

Show child attributes

Last modified on September 24, 2026

⌘I

Discover the URLs on a site

curl --request POST \
  --url https://api.truscan.co/api/crawl/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "limit": 5000,
  "search": "docs",
  "subdomains": false,
  "sitemap_only": false
}
'

import requests

url = "https://api.truscan.co/api/crawl/map"

payload = {
    "url": "https://example.com",
    "limit": 5000,
    "search": "docs",
    "subdomains": False,
    "sitemap_only": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com',
    limit: 5000,
    search: 'docs',
    subdomains: false,
    sitemap_only: false
  })
};

fetch('https://api.truscan.co/api/crawl/map', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.truscan.co/api/crawl/map"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com\",\n  \"limit\": 5000,\n  \"search\": \"docs\",\n  \"subdomains\": false,\n  \"sitemap_only\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "success": true,
  "message": "<string>",
  "result": {
    "url": "<string>",
    "urls": [
      "<string>"
    ],
    "total": 123,
    "sources": {
      "sitemap": 123,
      "links": 123
    },
    "truncated": true
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}

{
  "success": false,
  "message": "<string>",
  "result": {
    "code": "<string>"
  }
}