API Documentation

Returns the API status. Useful for monitoring and verifying the service is reachable.

Response

Example

# Request
GET /api/health

# Response 200
{
  "status": "ok"
}

Test a single proxy. Returns the proxy's working status, latency, exit-node geolocation, anonymity level, HTTPS support, and optional per-site reachability checks.

Request Body

Response Body

SiteCheckResult

Try It

Test up to 200 proxies concurrently. Each proxy is tested with up to 25 parallel connections. Returns an array of ProxyResult objects, one per input proxy.

Request Body

Response Body

Example

# Request
POST /api/check-bulk
Content-Type: application/json

{
  "proxies": [
    "socks5://1.2.3.4:1080",
    "http://5.6.7.8:8080"
  ],
  "timeout": 10,
  "targets": ["https://www.google.com"]
}

# Response 200
[
  {
    "input": "socks5://1.2.3.4:1080",
    "working": true,
    "protocol": "socks5",
    "latency_ms": 234.5,
    "anonymity": "elite",
    "country": "Germany",
    "isp": "Deutsche Telekom",
    ...
  },
  ...
]

Try It

Test if a website can be scraped using HTTPX, CloudScraper, or Playwright. Checks if specified CSS selectors return data through each method. Returns a scrape summary with element previews, media gallery, and a recommendation on which method to use.

Request Body

Response Body

ScrapeMethodResult

ScrapeTagResult

MediaItem

Example

# Request
POST /api/scrape-test
Content-Type: application/json

{
  "url": "https://example.com",
  "tags": ["img", "h1", "meta[property=\"og:image\"]"],
  "methods": ["httpx", "cloudscraper", "playwright"]
}

# Response 200
{
  "url": "https://example.com",
  "results": [
    {
      "method": "httpx",
      "success": true,
      "status_code": 200,
      "latency_ms": 142.3,
      "page_title": "Example Domain",
      "media_gallery": [
        {
          "url": "https://example.com/image.jpg",
          "media_type": "image",
          "alt": "Photo",
          "source_selector": "img"
        }
      ],
      "tags_found": {
        "img": [
          {
            "tag": "img",
            "text_preview": null,
            "attrs": {
              "src": "https://example.com/image.jpg",
              "alt": "Photo"
            },
            "media_url": "https://example.com/image.jpg",
            "media_type": "image"
          }
        ]
      }
    }
  ],
  "recommendation": "Multiple methods work: httpx, cloudscraper, playwright. Playwright is most reliable for JS-heavy sites."
}

Try It