{ "openapi": "3.0.1", "info": { "title": "SERP By WebUnlocker", "description": "🚀 Cheapest SERP Scraper – $0.50 / 1,000 searches! Scrape Google, Bing & DuckDuckGo with clean JSON output. Supports 🔥 Web/Text, 🖼 Image, 📰 News, 🎬 Video, 🛒 Shopping. Get organic results, ads, featured snippets, PAA & more with full geo-targeting. Fast, reliable & affordable.", "version": "2.0", "x-build-id": "Kv5ignsW4wylOVPJm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webunlocker~serp-by-webunlocker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webunlocker-serp-by-webunlocker", "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/webunlocker~serp-by-webunlocker/runs": { "post": { "operationId": "runs-sync-webunlocker-serp-by-webunlocker", "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/webunlocker~serp-by-webunlocker/run-sync": { "post": { "operationId": "run-sync-webunlocker-serp-by-webunlocker", "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": [ "queries" ], "properties": { "queries": { "title": "Search Queries", "type": "array", "description": "List of search queries (1-50 per run)", "items": { "type": "string" } }, "searchEngine": { "title": "Search Engine", "enum": [ "google", "bing", "duckduckgo" ], "type": "string", "description": "Search engine to use", "default": "google" }, "searchType": { "title": "Search Type", "enum": [ "text", "images", "news", "videos", "shopping" ], "type": "string", "description": "Type of search results", "default": "text" }, "pages": { "title": "Pages Per Query", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of pages to fetch per query (1-10)", "default": 10 }, "country": { "title": "Country", "enum": [ "us", "gb", "de", "fr", "es", "it", "ca", "au", "in", "br", "jp" ], "type": "string", "description": "Country for search results (ISO 3166-1 alpha-2)", "default": "us" }, "language": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "pt", "ja", "zh" ], "type": "string", "description": "Language for search results", "default": "en" }, "includeAds": { "title": "Include Ads", "type": "boolean", "description": "Include paid ads in results", "default": false }, "includePAA": { "title": "Include People Also Ask", "type": "boolean", "description": "Include People Also Ask section", "default": true }, "includeRelatedSearches": { "title": "Include Related Searches", "type": "boolean", "description": "Include related search suggestions", "default": true }, "includeLocalPack": { "title": "Include Local Pack", "type": "boolean", "description": "Include local pack / map results", "default": false }, "includeKnowledgePanel": { "title": "Include Knowledge Panel", "type": "boolean", "description": "Include knowledge panel data", "default": false }, "outputFormat": { "title": "Output Format", "type": "string", "description": "Output structure", "default": "full" }, "googleDomain": { "title": "Google Domain", "type": "string", "description": "Google domain (e.g. google.co.uk). Only for Google.", "default": "google.com" }, "dateRange": { "title": "Date Range", "type": "string", "description": "Filter by time: hour, day, week, month, year", "default": "" }, "safeSearch": { "title": "Safe Search", "enum": [ "off", "moderate", "strict" ], "type": "string", "description": "Adult content filter: off, moderate, strict", "default": "moderate" }, "fileType": { "title": "File Type", "type": "string", "description": "Filter by file type (e.g. pdf, doc). Google text search only." }, "siteFilter": { "title": "Site Filter", "type": "string", "description": "Restrict to domain (e.g. example.com). Prepended to query." }, "mobile": { "title": "Mobile", "type": "boolean", "description": "Request mobile results", "default": false }, "saveHtml": { "title": "Save Raw HTML (Debug)", "type": "boolean", "description": "Save raw HTML snapshots to key-value store 'serp-debug-html' for debugging.", "default": false }, "bingRecipeIntent": { "title": "Bing Recipe Intent", "type": "boolean", "description": "When true (Bing only), adds 'copycat recipe' to queries like 'like pizza hut' to favor recipe pages over locations.", "default": false }, "maxResults": { "title": "Max Results", "type": "integer", "description": "Results per query (10-100)", "default": 10 }, "maxRetries": { "title": "Max Retries", "type": "integer", "description": "Maximum retry attempts per query", "default": 3 }, "maxConcurrency": { "title": "Max Concurrency", "type": "integer", "description": "Maximum concurrent queries", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy configuration settings" }, "externalProxyUrl": { "title": "External Proxy URL", "type": "string", "description": "External relay proxy URL" }, "dataImpulseProxy": { "title": "DataImpulse Proxy", "type": "string", "description": "DataImpulse residential proxy URL" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }