v10

latestOpenAPI 3.1.02026-08-046324.9 KB

Scrapingant General Request

get/v2/general

Query parameters

x-api-keystring required

API token, required for authentication. You can find your API token on the dashboard page in the user's admin panel.

urlstring required

URL to scrape

browserboolean

Enables using headless browser for scraping. Default: true

return_page_sourceboolean

Enables returning data returned by the server and unaltered by the browser. Default: false. When true - JS won't be rendered. This feature works only with browser=true

cookiesstring

Cookies to pass with a scraping request to the target site.

js_snippetstring

Base64 encoded JS snippet to run once page being loaded in the ScrapingAnt browser. This feature works only with browser=true.

proxy_typestring

Specifies proxy type to make request from. Default: datacenter. one of: datacenter, residential

proxy_countrystring

Specifies proxy country to make request from. If not specified, the request will be made from a random country.

wait_for_selectorstring

The CSS selector of the element our service will wait for before returning result. This feature works only with browser=true

block_resourcestring

Block resource types. Prevents cloud browser from loading specified resource types. Can be repeated in case several resource types should be blocked. This feature works only with browser=true. Available resource types: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, other

Response

Successful response. ScrapingAnt web scraping API endpoint returns plain html content of the scraped web page

string required

Example response

"<html><head><title>Example</title></head><body><h1>Hello, World!</h1></body></html>"