Skip to main content
POST
Ask for a domain to be prepared for Extract

Authorizations

apikey
string
query
required

Fetch, Extract, Crawl and the account endpoint accept the key as the apikey query parameter. Keys are per account and self-serve: create one in the Zenrows dashboard (app.zenrows.com), or, for an agent with no human present, POST https://app.zenrows.com/api/agent/signup.

Headers

Idempotency-Key
string

The same key returns the original submission instead of spending a second allowance slot.

Body

application/json
domain
string
required

The domain to prepare, without scheme.

Example:

"scrapingcourse.com"

example_urls
string<uri>[]

URLs on that domain, one per kind of page. When present, they replace discovery.

Response

Accepted. The body is the submission in the same shape getExtractDomainStatus returns.

A domain's preparation for Extract.

domain
string
status
enum<string>

Whether the domain can be used yet. Branch on this.

Available options:
preparing,
ready,
failed
state
string

The current step. Gains steps over time.

Examples:

"received"

"discovering"

"preparing"

"verifying"

"ready"

"failed"

roles
object[]

Progress per kind of page. Only present for the account that submitted the domain.

failure
object

Present when status is failed.

submitted_at
string<date-time>
updated_at
string<date-time>