{ "openapi": "3.0.1", "info": { "title": "Google Search Scraper", "description": "Fast Google SERP scraper for SEO teams, marketers, and agencies. Collect live organic rankings, ads, People Also Ask, related searches, and knowledge panels by keyword, country, and language in clean page-based output.", "version": "0.5", "x-build-id": "ktAHaBrWiXzY6cAaF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vortex_data~google-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vortex_data-google-search", "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/vortex_data~google-search/runs": { "post": { "operationId": "runs-sync-vortex_data-google-search", "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/vortex_data~google-search/run-sync": { "post": { "operationId": "run-sync-vortex_data-google-search", "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": [ "keyword" ], "properties": { "keyword": { "title": "Search queries", "type": "string", "description": "Enter one Google search per line. You can also paste a full Google Search URL." }, "limit": { "title": "📄 Results to request", "enum": [ "10", "20", "30", "40", "50", "100", "all" ], "type": "string", "description": "How many results to request per search. Each 10 results equals one Google page. Select all to collect up to the standard Google result depth.", "default": "10" }, "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code such as US, GB, DE, FR, CA, AU, or BR. This selects the Google country domain and local results.", "default": "US" }, "language": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "pt", "nl", "pl", "ru", "uk", "tr", "ar", "hi", "ja", "ko", "zh-CN", "zh-TW" ], "type": "string", "description": "Language of the Google interface and result hints.", "default": "en" }, "dateRange": { "title": "🗓️ Freshness", "enum": [ "any", "pastDay", "pastWeek", "pastMonth", "pastYear" ], "type": "string", "description": "Limit results to a recent time period.", "default": "any" }, "mobileResults": { "title": "📱 Mobile results", "type": "boolean", "description": "Fetch the mobile version of Google results.", "default": false }, "exactMatch": { "title": "Exact phrase match", "type": "boolean", "description": "Search for each query as an exact phrase.", "default": false }, "site": { "title": "Search only one website", "pattern": "^$|^([\\w-]+\\.)+\\w+$", "type": "string", "description": "Limit results to a single domain, for example example.com.", "default": "" }, "fileTypes": { "title": "File types", "maxItems": 10, "type": "array", "description": "Optional file extensions such as pdf, docx, xlsx, or csv.", "items": { "type": "string" }, "default": [] }, "includeUnfilteredResults": { "title": "Show omitted results", "type": "boolean", "description": "Ask Google to include similar results that are normally hidden.", "default": false }, "saveHtmlToKeyValueStore": { "title": "Save page snapshots", "type": "boolean", "description": "Keep a copy of the original Google page. Useful when you want to review exactly what was returned.", "default": false }, "maxConcurrency": { "title": "Searches at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches can run at the same time. Keep the default unless you are running a large list.", "default": 5 }, "requestTimeoutSecs": { "title": "Wait time per search", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time in seconds to wait for one Google response.", "default": 60 }, "maxRequestRetries": { "title": "Retry failed searches", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a failed search before saving an error row.", "default": 2 } } }, "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 } } } } } } } } } }