Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required

The site to map, starting with http:// or https://. Usually the home page or a section such as https://docs.python.org/3/. Private and internal addresses are rejected.

Example:

"https://docs.python.org/3/"

Only return URLs related to this text, best matches first. Matches the link text and the URL.

Maximum string length: 500
Example:

"asyncio"

limit
integer
default:500

The most URLs to return. total still counts every match.

Required range: 1 <= x <= 5000
sitemap
enum<string>
default:include

include reads the sitemaps and the links on the site's pages, which finds the most. skip reads only page links. only reads only the sitemaps, which is fastest.

Available options:
include,
skip,
only
includeSubdomains
boolean
default:false

Also returns URLs on the site's subdomains, such as blog.example.com for example.com.

ignoreQueryParams
boolean
default:true

Treats URLs that differ only by their query string as one URL.

respectRobots
boolean
default:false

Leaves out URLs the site's robots.txt asks crawlers not to visit.

cookies
string

Cookies from your own signed-in browser session, as name=value; name2=value2, to map pages that need an account. Never stored.

Response

The map finished. links is empty, with a message saying why, when no URLs were found. You aren't charged then.

status
enum<string>
Available options:
success

The URLs, best matches first with search, up to limit.

total
integer

How many URLs matched the search, or how many were found without one. Can be more than links holds when it's capped by limit.

scanned
integer

Every URL found on the site, before the search filter. Missing when no URLs were found.

sources
object

Where the URLs came from.

creditsUsed
integer

1, or 0 when no URLs were found.

message
string

Only when no URLs were found. Says why and what to try.

durationMs
integer

How long the map took, in milliseconds.