v1
latestOpenAPI 3.1.02026-07-137321.6 KBPage text by URL
Returns the visible text content of a webpage specified by the URL. Can be used to feed data to LLM models. The response can be in plain text, JSON, or XML format based on the text_format parameter. Proxies and Chromium JavaScript rendering are used for page retrieval and processing. Returns JSON on error.
Query parameters
Format of the text response (plain by default). "plain" will return only the page body text. "json" and "xml" will return a json/xml with "title", "description" and "content" keys.
[Works only with text_format=json] Return links from the page body text (false by default). Useful for building web crawlers.
URL of the target page.
HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&headers[One]=value1&headers=[Another]=value2) or as a JSON encoded object (...&headers={"One": "value1", "Another": "value2"}).
Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000).
Execute on-page JavaScript using a headless browser (true by default).
Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page.
CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
Type of proxy. Use residential if your site restricts traffic from datacenters, or stealth for the most heavily protected sites with advanced anti-bot detection (datacenter by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details.
Country of the proxy to use (US by default).
Your own proxy URL to use instead of our built-in proxy pool in "http://user:password@host:port" format (<a target="_blank" href="https://webscraping.ai/proxies/smartproxy">Smartproxy</a> for example).
Type of device emulation.
Return error on 404 HTTP status on the target page (false by default).
Return error on redirect on the target page (false by default).
Custom JavaScript code to execute on the target page.
Response
Success