{ "openapi": "3.0.1", "info": { "title": "Google SERP & SEO Scraper", "description": "Extract public Google Search organic results, paid cards, People Also Ask questions, AI Overview text, and visible result totals.", "version": "2.0", "x-build-id": "tOpkhVWYIhLYJl1C8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-serp-seo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-serp-seo-scraper", "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/googleapi~google-serp-seo-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-serp-seo-scraper", "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/googleapi~google-serp-seo-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-serp-seo-scraper", "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", "properties": { "query": { "title": "Keyword", "maxLength": 300, "type": "string", "description": "One public Google Search phrase. Used when no query list or start URL is supplied." }, "searchQuery": { "title": "Keyword alias", "maxLength": 300, "type": "string", "description": "Compatibility alias for one public search phrase." }, "keywords": { "title": "Keyword list", "maxItems": 20, "type": "array", "description": "Compatibility list of public search phrases.", "items": { "type": "string", "minLength": 1, "maxLength": 300 } }, "queries": { "title": "Keyword searches", "maxItems": 20, "type": "array", "description": "Search phrases with optional language, country, and per-keyword total organic-result cap.", "items": { "type": "object", "properties": { "query": { "title": "Keyword", "description": "Public search phrase to analyze.", "type": "string", "minLength": 1, "maxLength": 300 }, "language": { "title": "Language", "description": "Google interface language code.", "type": "string", "default": "en", "maxLength": 20 }, "country": { "title": "Country", "description": "Two-letter Google country code.", "type": "string", "default": "US", "maxLength": 5 }, "maxResults": { "title": "Organic result limit", "description": "Maximum organic results to combine for this keyword across fetched pages.", "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } }, "required": [ "query" ], "additionalProperties": false } }, "startUrls": { "title": "Google Search URLs", "maxItems": 20, "type": "array", "description": "Public HTTPS Google /search URLs containing a q parameter. Existing Google parameters are retained; page and result-limit controls are applied consistently.", "items": { "type": "object", "properties": { "url": { "title": "Public Google Search URL", "description": "A public Google Search /search URL with a non-empty q parameter.", "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "urls": { "title": "Search URL alias", "maxItems": 20, "type": "array", "description": "Compatibility list of public Google Search /search URLs.", "items": { "type": "string" } }, "language": { "title": "Default language", "maxLength": 20, "type": "string", "description": "Two-letter language code, optionally followed by a region.", "default": "en" }, "country": { "title": "Default country", "maxLength": 5, "type": "string", "description": "Two-letter Google country code.", "default": "US" }, "maxResults": { "title": "Organic results per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum organic results combined from Google’s ten-result pages for each keyword.", "default": 10 }, "maxItems": { "title": "Maximum keyword records", "minimum": 1, "maximum": 20, "type": "integer", "description": "Global cap on keyword records emitted across all supplied keywords and URLs.", "default": 10 }, "page": { "title": "Starting page", "minimum": 1, "maximum": 100, "type": "integer", "description": "One-based Google results page to start from; page 2 uses Google’s observed start=10 offset.", "default": 1 }, "maxPages": { "title": "Maximum pages per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum consecutive ten-result pages to inspect for each keyword, starting at the selected page.", "default": 10 }, "includePaid": { "title": "Include paid cards", "type": "boolean", "description": "Include visible sponsored cards when Google displays them.", "default": true }, "includeProducts": { "title": "Include product offers", "type": "boolean", "description": "Include visible Sponsored Products, Popular products, and More products cards with their shown prices, sellers, delivery, ratings, and review links.", "default": true }, "includePaa": { "title": "Include People Also Ask", "type": "boolean", "description": "Include the visible question cards and any answer text already rendered on the page.", "default": true }, "includePaaAnswers": { "title": "Expand People Also Ask answers", "type": "boolean", "description": "Use a standard browser to expand a bounded number of public question cards. Disabled by default; requires JavaScript rendering.", "default": false }, "maxPaaExpansions": { "title": "Maximum expanded questions", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum People Also Ask cards opened when answer expansion is enabled.", "default": 5 }, "includeAiOverview": { "title": "Include AI Overview", "type": "boolean", "description": "Include the visible AI Overview introduction, sections, bullets, and cited public sources when present.", "default": true }, "includeSnippets": { "title": "Include result snippets", "type": "boolean", "description": "Include the text excerpts Google visibly shows under result cards.", "default": true }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Bounded timeout for each public Google Search page request.", "default": 30 }, "requestDelayMs": { "title": "Request delay (milliseconds)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Pause between public result-page requests.", "default": 200 }, "maxRetries": { "title": "Transient retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Finite retry count for transient request failures. Access boundaries are not retried or bypassed.", "default": 1 }, "retries": { "title": "Retries alias", "minimum": 0, "maximum": 3, "type": "integer", "description": "Compatibility alias for maxRetries." }, "renderJavaScript": { "title": "Render public Google Search", "type": "boolean", "description": "Use an ordinary browser for public search pages when enabled. GOOGLE_SERP uses its documented static HTTP transport. Public disclosures are bounded; access boundaries stop collection.", "default": true }, "browserWaitMs": { "title": "Browser wait (milliseconds)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Bounded wait for public Google Search content after navigation.", "default": 2500 }, "browserScrolls": { "title": "Browser scrolls", "minimum": 0, "maximum": 3, "type": "integer", "description": "Maximum ordinary page scrolls used to reveal lazy public result modules.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Configured proxies apply to HTTP and ordinary browser requests. GOOGLE_SERP uses its documented static HTTP transport and cannot expand browser-only answer panels." } } }, "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 } } } } } } } } } }