Key is set in the header \"X-SOAX-API-Secret\" , please request key from your contact at soax.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31421915","collectionId":"06a73d66-8544-4f66-8faf-6ca364d3d6b8","publishedId":"2sB2qi9JN2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-07-01T08:40:34.000Z"},"item":[{"name":"API Usage","item":[{"name":"Get Usage Statistics by Calls","id":"e5c795a7-d72a-4092-9089-968f24003003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-SOAX-API-Secret","value":"{{X-SOAX-API-Secret}}"}],"url":"https://scraping.soax.com/v1/stats/usage","auth":{"type":"apikey","apikey":{"value":"{{X-SOAX-API-Secret}}","key":"This API provides configuration settings for making web requests with proxy support, advanced response handling, resource blocking, and custom JavaScript execution capabilities.
\nproxy_settings)Optional. Configure proxy server settings for requests.
\nrequest)Optional settings for request handling, filtering, and interaction.
\nrequest.filters)Optional. Configure filtering for resources and requests.
\nrequest.execute_js)Optional. Allows executing custom JavaScript snippets on the page during different stages of loading.
\nEach object within the scripts array has the following structure:
The before_script and after_script objects can contain the following fields:
response)Configure the format and content of the response.
\nReturns default response (often minimal info, depends on server default).
\n{\n \"url\": \"https://shopee.tw/\",\n \"proxy_settings\": {\n \"country\": \"tw\",\n \"type\": 1\n }\n}\n\nMonitors specific XHR/Fetch calls and returns them.
\n{\n \"url\": \"https://shopee.tw/\",\n \"proxy_settings\": {\n \"country\": \"tw\"\n },\n \"request\": {\n \"filters\": {\n \"types\": [\"XHR\", \"Fetch\"],\n \"url_patterns\": [\"get_pc\"]\n }\n },\n \"response\": {\n \"xhr\": true\n }\n}\n\nReturns HTML body, a screenshot, and monitored XHR requests.
\n{\n \"url\": \"https://shopee.tw/\",\n \"proxy_settings\": {\n \"country\": \"tw\"\n },\n \"request\": {\n \"filters\": {\n \"types\": [\"XHR\", \"Fetch\"],\n \"url_patterns\": [\"get_pc\"]\n }\n },\n \"response\": {\n \"body\": true,\n \"screenshot\": true,\n \"xhr\": true\n }\n}\n\nUses a specific proxy and returns a screenshot.
\n{\n \"url\": \"https://shopee.tw/\",\n \"proxy_settings\": {\n \"proxy\": \"http://user:pass@proxy.example.com:8080\"\n },\n \"response\": {\n \"screenshot\": true\n }\n}\n\nLoads the page faster by blocking images and stylesheets, then returns the HTML body.
\n{\n \"url\": \"https://www.google.com/search?q=test+search\",\n \"request\": {\n \"filters\": {\n \"block_types\": [\n \"Stylesheet\",\n \"Image\"\n ]\n }\n },\n \"response\": {\n \"body\": true\n }\n}\n\nExecutes JavaScript to interact with a login form (example), waits for potential captcha elements, and returns the final page HTML along with cookies.
\n{\n \"url\": \"https://example.com/login\",\n \"proxy_settings\": {\n \"proxy\": \"http://user:pass@proxy.example.com:8080\"\n },\n \"request\": {\n \"execute_js\": {\n \"scripts\": [\n {\n \"script\": \"document.querySelector('#username').value='myuser';\"\n },\n {\n \"script\": \"document.querySelector('#password').value='mypass';\"\n },\n {\n \"script\": \"document.querySelector('#loginButton').click()\",\n \"after_script\": {\n \"sleep\": 5,\n \"wait_for_any\": [\"#captcha_element\", \".login-error\", \"#dashboard\"]\n }\n }\n ]\n }\n },\n \"response\": {\n \"body\": true,\n \"cookies\": true\n }\n}\n\nbody: true){\n \"html\": \"<html>....</html>\"\n}\n\nscreenshot: true){\n \"screenshot\": \"base64_encoded_image_data\"\n}\n\nxhr: true){\n \"requests\": [\n {\n \"url\": \"https://shopee.tw/api/v4/pdp/get_pc?param=value\",\n \"method\": \"GET\",\n \"headers\": { \"...\": \"...\" },\n \"response\": {\n \"status\": 200,\n \"headers\": { \"...\": \"...\" },\n \"body\": \"{...}\"\n }\n }\n // ... other matched requests\n ]\n}\n\nbody: true, screenshot: true, xhr: true){\n \"html\": \"<html></html>\",\n \"screenshot\": \"base64_encoded_image_data\",\n \"requests\": [\n {\n \"url\": \"https://shopee.tw/api/v4/pdp/get_pc\",\n \"method\": \"GET\",\n \"headers\": {},\n \"response\": {}\n }\n ]\n}\n\ncookies: true){\n \"html\": \"<html>...</html>\",\n \"cookies\": [\n {\n \"name\": \"session_id\",\n \"value\": \"abc123xyz\",\n \"domain\": \".example.com\",\n \"path\": \"/\",\n \"expires\": 1678886400,\n \"size\": 20,\n \"httpOnly\": true,\n \"secure\": true,\n \"session\": false,\n \"sameSite\": \"Lax\"\n },\n {\n \"name\": \"user_prefs\",\n \"value\": \"lang=en&theme=dark\",\n \"domain\": \"example.com\",\n \"path\": \"/\",\n \"expires\": -1,\n \"size\": 35,\n \"httpOnly\": false,\n \"secure\": false,\n \"session\": true\n }\n // ... other cookies\n ]\n}\n\nmarkdown: true, body: true){\n \"markdown\": \"# Page Title\\n\\nThis is a paragraph.\\n\\n* List item 1\\n* List item 2\\n\\n[Link text](https://example.com)\"\n}\n\n```
\n{\"success\": false, \"code\": 403, \"message\": \"key not found\"}\n\nProblem: Your API key is either missing, invalid, or has been revoked.
Actions to Take:
Verify you're including your API key in the request
\nCheck if the API key is correctly formatted
\nEnsure your account is active and in good standing
\nGenerate a new API key if necessary
\n{\"success\": false, \"code\": 400, \"message\": \"error unlocking url\"}\n\nProblem: Your request contains invalid parameters or formatting issues.
Actions to Take:
Check all required parameters are included
\nEnsure URL encoding is correct
\nVerify the syntax of your request body
\nReview API documentation for proper request structure
\n{\"success\": false, \"code\": 500, \"message\": \"error unlocking url\"}\n\nProblem: The system cannot access the requested resource, but the issue might be with your request.
Actions to Take:
Verify the URL is valid and accessible
\nTry adjusting or removing filters
\nCheck if the target site is online
\nConsider using different request parameters
\nWait a few minutes and try again
\nProblem: You've exceeded the rate limits for your account tier.
Actions to Take:
Implement request throttling in your application
\nSpace out your requests over time
\nConsider upgrading to a higher tier with increased limits
\nCheck your usage statistics in your account dashboard
\nCache results when possible to reduce API calls
\nImplement proper error handling in your code
\nUse exponential backoff for retries
\nMonitor your API usage regularly
\n