---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/tools/scrapper/interfaces/ScrapperArticleParams.md
description: Model-facing params for `/api/article`.
---

# Interface: ScrapperArticleParams

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

Model-facing params for `/api/article`.

## Extends

* [`ScrapperCommonParams`](ScrapperCommonParams.md)

## Properties

| Property                                                       | Type                                                              | Description                                                                                    | Inherited from                                                                                                                | Defined in                                                                                                                        |
| -------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|  `cache?`                           | `boolean`                                                         | Return a cached result when available instead of re-scraping.                                  | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`cache`](ScrapperCommonParams.md#property-cache)                           | [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.             | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`device`](ScrapperCommonParams.md#property-device)                         | [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). | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`extra_http_headers`](ScrapperCommonParams.md#property-extra_http_headers) | [batteries/tools/scrapper/index.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L68) |
|  `full_content?`             | `boolean`                                                         | Populate `fullContent` with the page's full HTML.                                              | -                                                                                                                             | [batteries/tools/scrapper/index.ts:76](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L76) |
|  `incognito?`                   | `boolean`                                                         | Run in an incognito browser context (no persisted browsing data). Default true upstream.       | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`incognito`](ScrapperCommonParams.md#property-incognito)                   | [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`.                               | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`proxy_server`](ScrapperCommonParams.md#property-proxy_server)             | [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`.                                    | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`screenshot`](ScrapperCommonParams.md#property-screenshot)                 | [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`.                      | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`scroll_down`](ScrapperCommonParams.md#property-scroll_down)               | [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.                                                   | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`sleep`](ScrapperCommonParams.md#property-sleep)                           | [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.   | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`timeout`](ScrapperCommonParams.md#property-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`).                                                         | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`user_agent`](ScrapperCommonParams.md#property-user_agent)                 | [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.                                                        | [`ScrapperCommonParams`](ScrapperCommonParams.md).[`wait_until`](ScrapperCommonParams.md#property-wait_until)                 | [batteries/tools/scrapper/index.ts:58](https://github.com/NHTIO/ADK/blob/v1.20260609.1/src/batteries/tools/scrapper/index.ts#L58) |