Skip to content

docs(extract): recommend several example URLs of one page type in prepareDomain #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
zenrows-dev-pool wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(extract): recommend several example URLs of one page type in prepareDomain #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e863640
docs(extract): recommend several example URLs of one page type in pre…
zenrows-dev-pool[bot] Oct 21, 2026
be94dbe
docs(extract): use the canonical example URL wording in prepareDomain
zenrows-dev-pool[bot] Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,11 @@ The legacy `402` with `code: "AUTH010"` means the domain isn't enabled. `extract

#### Preparing a domain

`client.prepareDomain(domain, exampleUrls)` submits a domain for Extract (`POST /v1/extract/prepared-domains`), and `client.preparedDomainStatus(domain)` reads where it is (`GET /v1/extract/prepared-domains/{domain}`). Both resolve to the parsed status object. Pass the domain without a scheme and 1 to 5 example URLs, one per kind of page you want to extract. These calls cost no credits.
`client.prepareDomain(domain, exampleUrls)` submits a domain for Extract (`POST /v1/extract/prepared-domains`), and `client.preparedDomainStatus(domain)` reads where it is (`GET /v1/extract/prepared-domains/{domain}`). Both resolve to the parsed status object. Pass the domain without a scheme and 1 to 5 example URLs on that domain. These calls cost no credits.

Preparation takes minutes, and the client does not wait for it. Poll the status until it is no longer `"preparing"`:
One example URL works; we recommend 3 or more of the same page type (e.g. 3 product pages), because Extract compares pages of one type to check the fields it found and fill in fields one page is missing. Several page types can share the 5 (e.g. 3 product pages + 2 search-result pages).

Preparation takes minutes, and the client does not wait for it. Poll the status until it is no longer `"preparing"`. This example prepares three product pages:

```javascript
import { ZenRows, ZenRowsPreparedDomainError } from "zenrows";
Expand All @@ -242,7 +244,9 @@ const client = new ZenRows("YOUR-API-KEY");

try {
let status = await client.prepareDomain("www.scrapingcourse.com", [
"https://www.scrapingcourse.com/ecommerce/",
"https://www.scrapingcourse.com/ecommerce/product/abominable-hoodie/",
"https://www.scrapingcourse.com/ecommerce/product/adrienne-trek-jacket/",
"https://www.scrapingcourse.com/ecommerce/product/aeon-capri/",
]);
while (status.status === "preparing") {
await new Promise((resolve) => setTimeout(resolve, 30_000));
Expand Down
9 changes: 6 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,12 @@ export class ZenRows {
* the parsed status object the API answers with `202`: `domain`, `status` (`"preparing"`,
* `"ready"` or `"failed"`), `state`, `submitted_at`, `updated_at`.
*
* `domain` is the domain without a scheme. `exampleUrls` are 1 to 5 URLs on that domain,
* one per kind of page you want to extract. Submitting a domain that is already prepared
* returns its current status instead of starting a new run.
* `domain` is the domain without a scheme. `exampleUrls` are 1 to 5 example URLs on that
* domain. One works; we recommend 3 or more of the same page type (e.g. 3 product pages),
* because Extract compares pages of one type to check the fields it found and fill in fields
* one page is missing. Several page types can share the 5 (e.g. 3 product pages + 2
* search-result pages). Submitting a domain that is already prepared returns its current
* status instead of starting a new run.
*
* Preparation takes minutes. This method does not wait for it: call
* `preparedDomainStatus(domain)` until `status` is no longer `"preparing"`. These endpoints
Expand Down
Loading