ScrapeForge Parameters
Complete parameter reference for enterprise web scraping
Enterprise Features
Core Parameters
Essential ScrapeForge Parameters
Parameter | Type | Required | Description |
---|---|---|---|
url | string | Required | The target URL to scrape. Must be a valid HTTP/HTTPS URL with proper encoding. Example: |
render_js | boolean | Optional | Execute JavaScript on the page using a real browser engine (Chromium). Example: |
wait_for | string | Optional | CSS selector or XPath to wait for before considering the page loaded. Example: |
wait_time | integer | Optional | Maximum time to wait for the wait_for element in seconds. Example: |
user_agent | string | Optional | Custom User-Agent string to use for the request. Example: |
proxy_type | string | Optional | Type of proxy to use for the request. Example: |
proxy_country | string | Optional | Target country for proxy location using ISO 3166-1 alpha-2 codes. Example: |
Advanced Parameters
Advanced Extraction & Rendering Options
Parameter | Type | Required | Description |
---|---|---|---|
extract_links | boolean | Optional | Extract all links found on the page with their text and attributes. Example: |
extract_images | boolean | Optional | Extract all images with their URLs, alt text, and dimensions. Example: |
extract_schema | boolean | Optional | Extract structured data (JSON-LD, Microdata, RDFa) from the page. Example: |
extract_meta | boolean | Optional | Extract meta tags, Open Graph, and Twitter Card data. Example: |
custom_headers | object | Optional | Custom HTTP headers to include with the request. Example: |
cookies | object | Optional | Cookies to include with the request. Example: |
screenshot | boolean | Optional | Capture a screenshot of the page (requires render_js=true). Example: |
screenshot_options | object | Optional | Screenshot configuration options. Example: |
Bulk Scraping Parameters
Bulk Processing Options
Parameter | Type | Required | Description |
---|---|---|---|
urls | array | Required | Array of URLs to scrape in bulk (max 100 URLs per request). Example: |
concurrent_requests | integer | Optional | Number of URLs to process simultaneously. Example: |
retry_failed | boolean | Optional | Automatically retry failed requests with different proxies. Example: |
max_retries | integer | Optional | Maximum number of retry attempts for failed requests. Example: |
callback_url | string | Optional | Webhook URL to receive results asynchronously. Example: |
Bulk Scraping Limits
Credit Consumption
Response Format
ScrapeForge Response Fields
Field | Type | Description |
---|---|---|
content | string | The raw HTML content of the scraped page. Example: |
text_content | string | Plain text content extracted from HTML (JavaScript-rendered if applicable). Example: |
links | array | Array of link objects with URL, text, and attributes (if extract_links=true). Example: |
images | array | Array of image objects with src, alt, and dimensions (if extract_images=true). Example: |
schema_data | array | Structured data found on the page (if extract_schema=true). Example: |
meta_data | object | Meta tags, Open Graph, and Twitter Card data (if extract_meta=true). Example: |
screenshot_url | string | URL to the captured screenshot (if screenshot=true). Example: |
load_time | float | Total time taken to load and process the page in seconds. Example: |
status_code | integer | HTTP status code returned by the target server. Example: |
final_url | string | Final URL after following redirects. Example: |
credits_used | integer | Number of API credits consumed by this request. Example: |
Example Requests
Basic Request
Simple scraping without JavaScript rendering for static content:
Basic ScrapeForge Request
curl -X POST https://www.searchhive.dev/api/v1/scrapeforge \
-H "Authorization": "Bearer: sk_live_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/products",
"render_js": false,
"extract_links": true
}'
Advanced Request
Full-featured scraping with all extraction options and JavaScript rendering:
Advanced ScrapeForge Request
Technical Details
Parameter Best Practices
Only enable for dynamic content to save credits and time.
Use specific selectors for critical elements.
Residential for high-protection sites, datacenter for speed.
Use bulk endpoint for multiple URLs from same domain.
Test selectors in browser dev tools first.
Allow sufficient time for slow-loading content.
Some sites require specific headers for access.
Ensure header names and values are properly formatted.