Getting Started
API Access Key & Authentication
After creating a scrapestack account, the account dashboard will reveal the unique API access key you can use to authenticate with the API. To do so, simply attach the access_key parameter to the API's base URL and set it to your API access key.
Secure your key: To prevent unauthorized access to your scrapestack account, please make sure to store your API access key in a secure location and never include it in any public scripts or files.
256-bit HTTPS Encryption
All customers may connect to the scrapestack API using industry-standard 256-bit HTTPS (SSL) encryption by appending an s to the HTTP protocol. Please find an illustration below.
Example API Request:
Available on all plans
API Error Codes
If your request fails, the scrapestack API will return an error in JSON format. Find below an example error that occurs when the API fails to scrape the requested URL.
Example Error:
Common API Errors:
| Code | Type | Info |
|---|---|---|
404 | 404_not_found | User requested a resource which does not exist. |
101 | missing_access_key | User did not supply an access key. |
101 | invalid_access_key | User supplied an invalid access key. |
102 | inactive_user | User account is inactive or blocked. |
103 | invalid_api_function | User requested a non-existent API function. |
104 | usage_limit_reached | User has reached his subscription's monthly request allowance. |
105 | function_access_restricted | The user's current subscription does not support this API function. |
210 | missing_url | User has not specified a valid URL to scrape. |
211 | invalid_url | User has specified an invalid value in the URL parameter. |
212 | invalid_proxy_location | User has specified an invalid or unsupported proxy location. |
213 | scrape_request_failed | The current scraping request failed due to a technical issue. If this error occurs, please report this to technical customer support. |