Cost: 1 credit (non-proxy)
Cost: 5 credits (proxy)
POST
/
scrape
/
web
cURL
curl --request POST \
  --url https://api.workfloo.ws/v0/scrape/web \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://workfloows.com",
  "proxy": {
    "enabled": false
  },
  "output": {
    "html": false,
    "markdown": false,
    "links": false
  }
}'
{
  "response": {
    "success": true,
    "proxy_used": false
  },
  "results": {
    "text": "Page content..."
  }
}
Scrapes textual content from a given public website URL. Allows optional proxying and multiple output formats: HTML, Markdown, or link extraction. Requires a valid API key.

​
Non-proxy scrape

When proxying is not enabled, scraping is performed using standard data center IPs. Some websites may block such traffic. If proxy is disabled, the response includes: 
"response": {
    "success": true,
    "proxy_used": false
}

​
Proxy scrape

When proxying is enabled, the scraper follows these steps:
  1. Attempts a regular (non-proxy) scrape.
  2. If access is blocked, it retries using a proxy.
  3. If a CAPTCHA is detected, it attempts to solve it.
  4. The final result is returned to the client.
If proxy is enabled, the response includes additional diagnostic information: 
"response": {
    "success": true,
    "proxy_used": true,
    "bot_detected": true,
    "captcha_detected": true,
    "captcha_solved": true
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
required

Target URL to scrape (including protocol)

Example:

"https://workfloows.com"

​
proxy
object

Proxy settings

​
output
object

Output formatting options

Response

Successful response

​
response
object
​
results
object