Overview
FoxScrape's HTML API base URL is:
JSON
1https://www.foxscrape.com/api/v1
Here is the list of the different parameters you can use with FoxScrape's HTML API.
| Name | Description |
|---|---|
api_key stringrequired | Your API key |
url stringrequired | The URL of the page you want to scrape |
ai_extract_rules stringified JSON{} | Data extraction from description using AI |
ai_query string"" | The information you want to extract from the webpage using AI |
ai_selector string"" | CSS selector to focus the AI extraction on a specific part of the page |
block_ads booleantrue | Block ads on the page you want to scrape |
block_resources booleantrue | Block images and CSS on the page you want to scrape |
cookies string"" | Pass custom cookies to the webpage you want to scrape |
device stringdesktop | Control the device the request will be sent from |
extract_rules stringified JSON{} | Data extraction from CSS selectors |
forward_headers booleanfalse | Forward particular headers to the webpage, as well as other headers generated by FoxScrape |
forward_headers_pure booleanfalse | Forward only particular headers to the webpage, and nothing else |
js_scenario stringified JSON{} | JavaScript scenario to execute |
json_response booleanfalse | Wrap response in JSON |
render_js booleantrue | Render the JavaScript on the page with a headless browser |
return_page_markdown booleanfalse | Return the page content in markdown format |
return_page_source booleanfalse | Return the original HTML before the JavaScript rendering |
return_page_text booleanfalse | Return the text content of the page you want to scrape |
scraping_config string"" | Use a pre-saved request configuration on your request |
screenshot booleanfalse | Return a screenshot of the page you want to scrape |
screenshot_full_page booleanfalse | Return a screenshot of the full page you want to scrape |
screenshot_selector string"" | Return a screenshot of a particular area of the page, targeted by a CSS selector |
timeout integer60,000 | Timeout for your requests in milliseconds |
wait integer0 | Additional time in ms for JavaScript to render |
wait_browser stringdomcontentloaded | Wait until certain browser conditions are met before returning the response |
wait_for string"" | CSS / XPath selector to wait for in the DOM |
window_height integer1080 | Height, in pixel, of the viewport used to render the page you want to scrape |
window_width integer1920 | Width, in pixel, of the viewport used to render the page you want to scrape |