Skip to main content
POST
Best for finding the right page on a site before reading it with scrape.
Works without an API key within the free limits. See Rate limits.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A value you choose for one call. Send the same key with the same method, path and body within 24 hours and the first answer comes back with idempotent-replayed: true, with the same cost headers and no second charge. A call that sends zeroDataRetention and answers with page data is not kept, so a retry runs again. Needs an API key.

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

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.

deduplicateSimilarURLs
boolean

Send false to list distinct addresses such as /docs/a, /docs/a/ and /docs/a.md.

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

Where to read the page from. The default is the United States.

Response

The data, and what this call cost in dollars.

success
boolean
required