{ "openapi": "3.0.1", "info": { "title": "Google Search Results Scraper: Organic & SERP Boxes", "description": "Search Google and get organic results plus AI Overview, knowledge panel, People Also Ask, related searches, local pack, top stories and ads for each query, across 48 countries with language and date filters.", "version": "1.0", "x-build-id": "NG6Y2OAdaEEnxj85d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~google-search-results-scraper-organic-and-serp/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-google-search-results-scraper-organic-and-serp", "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/vexaloom-labs~google-search-results-scraper-organic-and-serp/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-google-search-results-scraper-organic-and-serp", "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/vexaloom-labs~google-search-results-scraper-organic-and-serp/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-google-search-results-scraper-organic-and-serp", "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", "minItems": 1, "type": "array", "description": "Google search queries. Each is searched separately; blank entries are dropped with a warning.", "items": { "type": "string" } }, "searchType": { "title": "Search type", "enum": [ "web", "news", "images", "videos" ], "type": "string", "description": "Which Google surface to scrape: web organic results, news cards, images, or videos.", "default": "web" }, "maxResults": { "title": "Max results per query", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum items to return per query. Web results stop at Google's own ceiling of roughly 70-100; images return 50-100 per query and news/videos paginate in pages of 10.", "default": 100 }, "countryCode": { "title": "Country", "enum": [ "", "us", "uk", "ca", "au", "de", "fr", "es", "it", "br", "mx", "in", "jp", "kr", "nl", "be", "at", "ch", "se", "no", "dk", "fi", "pl", "cz", "pt", "ie", "nz", "za", "sg", "hk", "tw", "ph", "th", "id", "my", "vn", "ar", "cl", "co", "pe", "tr", "ru", "ua", "il", "ae", "sa", "eg", "ng", "ke" ], "type": "string", "description": "Country for the Google domain and searcher-location (gl) signal. Leave empty for US (google.com); if Precise Location is set and this is empty, the country is derived from it.", "default": "" }, "restrictResultsCountry": { "title": "Restrict results to country (cr)", "enum": [ "", "us", "uk", "ca", "au", "de", "fr", "es", "it", "br", "mx", "in", "jp", "kr", "nl", "be", "at", "ch", "se", "no", "dk", "fi", "pl", "cz", "pt", "ie", "nz", "za", "sg", "hk", "tw", "ph", "th", "id", "my", "vn", "ar", "cl", "co", "pe", "tr", "ru", "ua", "il", "ae", "sa", "eg", "ng", "ke" ], "type": "string", "description": "Only return pages whose content originates from this country (Google's cr parameter), independent of Country/gl. Leave empty for no restriction.", "default": "" }, "languageCode": { "title": "Interface language (hl)", "type": "string", "description": "Language of Google's own interface, e.g. en, de, fr, es. This does not restrict the language of the matched pages.", "default": "" }, "restrictResultsLanguage": { "title": "Restrict results language (lr)", "type": "string", "description": "Only return pages written in this language, e.g. en or en,fr for either. Leave empty for no restriction.", "default": "" }, "maxPagesPerQuery": { "title": "Max pages per query", "minimum": 1, "maximum": 10, "type": "integer", "description": "Result pages to crawl per query for web, news and videos. Images are a single page. Web results stop at Google's own ceiling of roughly 7-10 pages.", "default": 1 }, "timePeriod": { "title": "Time period", "enum": [ "", "hour", "day", "week", "month", "year" ], "type": "string", "description": "Filter results by relative time. Leave empty for any time.", "default": "" }, "safeSearch": { "title": "SafeSearch", "enum": [ "", "active", "off" ], "type": "string", "description": "Filter explicit content (safe=). Leave empty for Google's default.", "default": "" }, "includeAiOverview": { "title": "Include AI Overview (slower, best-effort)", "type": "boolean", "description": "Opt-in browser-rendered AI Overview for web searches. Slower and not guaranteed: Google may not show one, and the text is best-effort. Only applies to web search.", "default": false }, "includeDestinationUrl": { "title": "Resolve real result URLs", "type": "boolean", "description": "Add a destinationUrl field with the real destination behind Google's redirect link. Adds one lookup per organic result. Only applies to web search.", "default": false }, "csvFriendlyOutput": { "title": "CSV friendly output (one result per row)", "type": "boolean", "description": "For web search, output one organic/paid result per row instead of one SERP page per row. Other SERP features are not included in this layout.", "default": false }, "includeExtraBoxes": { "title": "Include extra info boxes", "type": "boolean", "description": "For web search, also extract weather, time zone, currency/unit converter, stock, jobs, videos, shopping and dictionary boxes when present.", "default": false }, "uule": { "title": "Precise location (uule)", "type": "string", "description": "Optional Google-encoded location for city-level targeting. Best-effort: country targeting is reliable, city precision is not guaranteed. Leave empty to use Country only." }, "dateFrom": { "title": "Date from", "type": "string", "description": "Only include results published on or after this date (YYYY-MM-DD). Must be used with Date to." }, "dateTo": { "title": "Date to", "type": "string", "description": "Only include results published on or before this date (YYYY-MM-DD). Must be used with Date from." }, "exactPhrase": { "title": "Exact phrase match", "type": "boolean", "description": "Wrap each query in quotes so Google matches it as an exact phrase.", "default": false }, "site": { "title": "Site (site: operator)", "type": "string", "description": "Restrict results to this domain, e.g. nike.com. Every organic result is checked against it; off-domain results Google slips in are dropped." }, "intitle": { "title": "Word in title (intitle:)", "type": "string", "description": "Restrict results to pages containing this word in the title. Sent to Google as-is." }, "intext": { "title": "Word in text (intext:)", "type": "string", "description": "Restrict results to pages containing this word in the body text. Sent to Google as-is." }, "inurl": { "title": "Word in URL (inurl:)", "type": "string", "description": "Restrict results to pages containing this word in the URL. Sent to Google as-is." }, "fileType": { "title": "File type (filetype:)", "type": "string", "description": "Restrict results to a file type, e.g. pdf, doc, xls. Sent to Google as-is." }, "excludeTerms": { "title": "Exclude terms (-word)", "type": "string", "description": "Words to exclude, comma- or space-separated, e.g. jaguar, cats." } } }, "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 } } } } } } } } } }