Interface: ScrapperArticleParams
Defined in: batteries/tools/scrapper/index.ts:74
Model-facing params for /api/article.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
cache? | boolean | Return a cached result when available instead of re-scraping. | ScrapperCommonParams.cache | batteries/tools/scrapper/index.ts:50 |
device? | string | Emulated device, e.g. Desktop Chrome. Overrides individual viewport/UA settings. | ScrapperCommonParams.device | batteries/tools/scrapper/index.ts:64 |
extra_http_headers? | string | Extra headers the SCRAPER's browser sends to the TARGET site, K:v;K2:v2 (NOT instance auth). | ScrapperCommonParams.extra_http_headers | batteries/tools/scrapper/index.ts:68 |
full_content? | boolean | Populate fullContent with the page's full HTML. | - | batteries/tools/scrapper/index.ts:76 |
incognito? | boolean | Run in an incognito browser context (no persisted browsing data). Default true upstream. | ScrapperCommonParams.incognito | batteries/tools/scrapper/index.ts:54 |
proxy_server? | string | Upstream proxy, e.g. http://host:3128 or socks5://host:1080. | ScrapperCommonParams.proxy_server | batteries/tools/scrapper/index.ts:70 |
screenshot? | boolean | Capture a screenshot; the result carries a screenshotUri. | ScrapperCommonParams.screenshot | batteries/tools/scrapper/index.ts:52 |
scroll_down? | number | Scroll down N pixels for lazy-loading pages. Requires a positive sleep. | ScrapperCommonParams.scroll_down | batteries/tools/scrapper/index.ts:62 |
sleep? | number | Wait this many ms after load before parsing. | ScrapperCommonParams.sleep | batteries/tools/scrapper/index.ts:60 |
timeout? | number | Browser navigation timeout in ms (0 disables). Distinct from the tool's own fetch timeout. | ScrapperCommonParams.timeout | batteries/tools/scrapper/index.ts:56 |
user_agent? | string | Explicit user-agent (prefer device). | ScrapperCommonParams.user_agent | batteries/tools/scrapper/index.ts:66 |
wait_until? | "load" | "domcontentloaded" | "networkidle" | "commit" | When navigation is considered finished. | ScrapperCommonParams.wait_until | batteries/tools/scrapper/index.ts:58 |