{ "openapi": "3.0.1", "info": { "title": "Web Search & Scrape by XCrawl Proxy", "description": "Search the web or scrape any URL using XCrawl residential proxy network. Bypass anti-bot systems with automatic JS rendering fallback, global IP rotation, and configurable concurrency (1-20). Perfect for market research, LLM data collection, and content aggregation.", "version": "2.0", "x-build-id": "Uweyf0KUIuE173kTi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/empathetic_chorus~xcrawl-search-scrape/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-empathetic_chorus-xcrawl-search-scrape", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/empathetic_chorus~xcrawl-search-scrape/runs": { "post": { "operationId": "runs-sync-empathetic_chorus-xcrawl-search-scrape", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/empathetic_chorus~xcrawl-search-scrape/run-sync": { "post": { "operationId": "run-sync-empathetic_chorus-xcrawl-search-scrape", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "search", "scrape" ], "type": "string", "description": "Action to perform: 'search' for web search, 'scrape' for single page extraction", "default": "search" }, "query": { "title": "Search Query", "maxLength": 200, "type": "string", "description": "Search query (required for action=search)" }, "url": { "title": "URL to Scrape", "maxLength": 2000, "type": "string", "description": "URL to scrape (required for action=scrape)" }, "location": { "title": "Geo-Location", "type": "string", "description": "Search location code (e.g. 'US', 'UK', 'CN', 'JP', 'DE', 'AU')", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Search language code (e.g. 'en', 'zh', 'ja', 'fr')", "default": "en" }, "limit": { "title": "Result Limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Number of search results to return (1-50)", "default": 10 }, "withContent": { "title": "Fetch Full Content", "type": "boolean", "description": "When enabled, automatically fetches full page content (markdown + summary) for each search result.", "default": true }, "formats": { "title": "Output Formats", "type": "string", "description": "Comma-separated output formats. Options: markdown, summary, html. (e.g. 'markdown,summary')", "default": "markdown,summary" }, "render": { "title": "JS Rendering (Anti-Bot)", "type": "boolean", "description": "Enable headless browser rendering to bypass Cloudflare/DataDome. Slower but more effective for protected sites.", "default": false }, "screenshot": { "title": "Take Screenshot", "type": "boolean", "description": "Capture a PNG screenshot of each page (requires render=true)", "default": false }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of parallel scrapes (1-20, default 5)", "default": 5 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }