---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperCommonParams.md
description: >-
  Model-facing params common to both verbs (snake_case; mapped to kebab on the
  wire).
---

# Interface: ScrapperCommonParams

Defined in: [batteries/tools/scrapper/index.ts:48](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L48)

Model-facing params common to both verbs (snake\_case; mapped to kebab on the wire).

## Extended by

* [`ScrapperArticleParams`](ScrapperArticleParams.md)
* [`ScrapperLinksParams`](ScrapperLinksParams.md)

## Properties

| Property                                                       | Type                                                              | Description                                                                                    | Defined in                                                                                                                        |
| -------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|  `cache?`                           | `boolean`                                                         | Return a cached result when available instead of re-scraping.                                  | [batteries/tools/scrapper/index.ts:50](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L50) |
|  `device?`                         | `string`                                                          | Emulated device, e.g. `Desktop Chrome`. Overrides individual viewport/UA settings.             | [batteries/tools/scrapper/index.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L64) |
|  `extra_http_headers?` | `string`                                                          | Extra headers the SCRAPER's browser sends to the TARGET site, `K:v;K2:v2` (NOT instance auth). | [batteries/tools/scrapper/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L68) |
|  `incognito?`                   | `boolean`                                                         | Run in an incognito browser context (no persisted browsing data). Default true upstream.       | [batteries/tools/scrapper/index.ts:54](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L54) |
|  `proxy_server?`             | `string`                                                          | Upstream proxy, e.g. `http://host:3128` or `socks5://host:1080`.                               | [batteries/tools/scrapper/index.ts:70](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L70) |
|  `screenshot?`                 | `boolean`                                                         | Capture a screenshot; the result carries a `screenshotUri`.                                    | [batteries/tools/scrapper/index.ts:52](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L52) |
|  `scroll_down?`               | `number`                                                          | Scroll down N pixels for lazy-loading pages. Requires a positive `sleep`.                      | [batteries/tools/scrapper/index.ts:62](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L62) |
|  `sleep?`                           | `number`                                                          | Wait this many ms after load before parsing.                                                   | [batteries/tools/scrapper/index.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L60) |
|  `timeout?`                       | `number`                                                          | Browser navigation timeout in ms (`0` disables). Distinct from the tool's own fetch timeout.   | [batteries/tools/scrapper/index.ts:56](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L56) |
|  `user_agent?`                 | `string`                                                          | Explicit user-agent (prefer `device`).                                                         | [batteries/tools/scrapper/index.ts:66](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L66) |
|  `wait_until?`                 | `"load"` | `"domcontentloaded"` | `"networkidle"` | `"commit"` | When navigation is considered finished.                                                        | [batteries/tools/scrapper/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L58) |