factget
Request Access
Developer hub
Console
Developers /Crawl API

Map a website

A site's URLs (sitemaps, link crawl, Common Crawl, Wayback), ranked by search.

POST/crawl/v1/map
POST example
curl --request POST \
  --url 'https://factget.dev/crawl/v1/map' \
  --header "Authorization: Bearer $FACTGET_CRAWL_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com",
  "limit": 100
}'

Replace IDs and sample values with your own. Examples are not executed in your browser.

Authorization

Authorizationstring · header · required

Bearer Crawl API key with the required scope. Learn about authentication →

Request body

application/json
urlstringrequired

The public URL to read.

originstring | null
maxLength: 200
searchstring | null
maxLength: 500
limitinteger

Maximum number of results or pages for this operation.

Default: 5000minimum: 1maximum: 30000
includeSubdomainsboolean
Default: false
sourcesstring[] | null
Allowed: "auto", "sitemap", "crawl", "cc", "archive"
ignoreSitemapboolean
Default: false
sitemapOnlyboolean
Default: false
liveCheckboolean
Default: false
timeoutinteger | null

How long to wait for the operation, in milliseconds, before returning a job to poll.

minimum: 10000maximum: 300000

Responses

200Successful Response
application/json

The published schema does not define individual response fields for this endpoint. Inspect the returned JSON in your integration.

422Validation Error
application/json
detailobject[]
Show item properties
locstring | integer[]required
msgstringrequired
typestringrequired
inputobject
ctxobject

The API schema lists the responses above. Long-running operations can also return 202; see async jobs. For application errors, see errors & retries.

FactGet developer documentationBack to API overview