Skip to main content
POST
List every page on a website
  • Endpoint: site.map
  • Returns: data has urls, source, sitemaps.
  • Cost: 2 credits per 500 items, at least 2 credits. Failed calls cost nothing.
  • Paging: Yes. Send the cursor from the response to get the next page. See Paging.

Example

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string
required
include
string[]
Maximum array length: 20
Required string length: 1 - 200
exclude
string[]
Maximum array length: 20
Required string length: 1 - 200
limit
integer
default:1000
Required range: 1 <= x <= 10000
cursor
string
Pattern: ^[\da-f]{32}$

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required