Skip to main content
POST
Best for finding the right page on a site before reading it with scrape. Add search to rank pages about one topic first.
Works without an API key, up to 10 calls a minute and 50 a day per IP. See Rate limits.

Price

1 credit per call. See Pricing for what credits cost.

Authorizations

Authorization
string
header
required

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

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
url
string
required

Any page of the site to map, such as https://bun.com.

Keep only addresses that mention these words, best matches first, such as pricing.

Minimum string length: 1
sitemap
enum<string>
default:include

include uses the site's sitemaps and its pages. only lists just what the sitemaps name. skip ignores the sitemaps.

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

Also list pages on subdomains, such as docs.bun.com for bun.com.

ignoreQueryParameters
boolean
default:true

List each page once, without its ?query part.

ignoreCache
boolean
default:false

Send true to build the list again instead of reusing one made in the last 6 hours.

limit
integer
default:5000

The most addresses to return, up to 100000.

Required range: 1 <= x <= 100000
timeout
integer

Stop looking after this many milliseconds and return what was found.

Required range: 1000 <= x <= 9007199254740991
location
object
auditMetadata
any
threatProtection
any

Response

The data, and the credits this call used.

success
boolean
required