{ "openapi": "3.0.1", "info": { "title": "Google Search Result Scraper", "description": "Google Search Result Scraper extracts organic and paid results, ads, Related, People Also Ask, News, Videos and Images Answers. Supports all available markets and languages. Download data as HTML table, JSON, CSV, Excel, XML or RSS", "version": "0.0", "x-build-id": "4ohqU1WxkernaOs2t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getdataforu~google-search-result-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getdataforu-google-search-result-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/getdataforu~google-search-result-scraper/runs": { "post": { "operationId": "runs-sync-getdataforu-google-search-result-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/getdataforu~google-search-result-scraper/run-sync": { "post": { "operationId": "run-sync-getdataforu-google-search-result-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", "required": [ "searchTerms", "maxResults" ], "properties": { "searchTerms": { "title": "Search queries or URLs", "minItems": 1, "type": "array", "description": "Required. Each row is scraped separately; the global Max results cap is divided evenly across all rows (and regions).", "items": { "type": "string" } }, "maxResults": { "title": "Max results (total)", "minimum": 1, "type": "integer", "description": "Maximum organic results for the whole run. Split evenly across keywords (e.g. 100 keywords + 1000 max → ~10 per keyword). With multiple regions, each keyword's share is split across regions.", "default": 30 }, "regions": { "title": "Regions (country + language)", "type": "array", "description": "Optional. Scrape each keyword in every listed region. When empty, Country and Language below are used as a single region.", "items": { "type": "object", "properties": { "country": { "title": "Country code (cc)", "type": "string", "description": "Bing cc= code, e.g. vn, us", "editor": "textfield" }, "language": { "title": "Language code", "type": "string", "description": "Bing setlang= code, e.g. vi, en", "editor": "textfield" } }, "required": [ "country" ] }, "default": [] }, "country": { "title": "Country / market (cc)", "type": "string", "description": "Default Bing region when Regions is empty. Uses mkt=vi-VN and ensearch=0 for localized results.", "default": "vn" }, "language": { "title": "Language code", "type": "string", "description": "Default language when Regions is empty or a region omits language. Bing setlang=, e.g. vi, en.", "default": "vi" }, "useBrowser": { "title": "Use browser on Apify Cloud", "type": "boolean", "description": "On Apify Cloud, uses Playwright with vi-VN locale and Vietnam geolocation (required). Set run memory to at least 2048 MB. Locally defaults to Cheerio HTTP.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Enable only if your Apify plan includes proxies in the target country (e.g. VN). Default is off — auto proxy caused 407 errors on plans without VN proxies.", "default": { "useApifyProxy": false } }, "includeSnippets": { "title": "Include snippets", "type": "boolean", "description": "When true, organic rows include the Bing caption text in the description field.", "default": true }, "includeAds": { "title": "Include ads (reserved)", "type": "boolean", "description": "Reserved for future paid-result extraction; currently ignored by the scraper.", "default": false } } }, "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 } } } } } } } } } }