Getting started
Helicity Labs
One POST gets you a page. The rest of these docs are about what happens when it doesn't.
The API has one endpoint that matters: POST /scrape. Give it a URL and a proxy
type, get the page back.
curl -X POST 'https://api.helicitylabs.com/scrape' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY' \
-d '{
"url": "https://example.com/orders",
"render_js": true,
"proxy_type": "premium"
}'Everything else — proxies, sessions, logins, batches, schedules — is a parameter on that request or a way of running it repeatedly.
What makes a response
Every response carries ok. When it is true you have a page. When it is
false you have an error_class naming what went wrong and a retryable flag
saying whether trying again could help.
{
"ok": false,
"error_class": "timeout",
"error_detail": "timed out after 15000ms",
"retryable": true,
"url": "https://example.com/orders",
"elapsed_ms": 15002
}That shape is the point of the product. Your code branches on error_class
rather than guessing from an empty list, and a run that failed on our side is
not charged — see Credits.