{ "openapi": "3.0.1", "info": { "title": "Google Shopping Insights Scraper", "description": "Extract public product prices, merchant offers, product facts, typical price ranges, and review insights shown in Google Shopping.", "version": "2.0", "x-build-id": "yDJt1Zk1JBb4BZIYd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-shopping-insights-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-shopping-insights-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-shopping-insights-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-shopping-insights-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-shopping-insights-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-shopping-insights-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": { "queries": { "title": "Search queries", "minItems": 1, "maxItems": 20, "type": "array", "description": "Product search terms to process.", "items": { "type": "string", "minLength": 1 } }, "query": { "title": "Search query", "minLength": 1, "type": "string", "description": "A single product search term. Use this instead of queries when running one search." }, "maxResultsPerQuery": { "title": "Maximum products per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of unique product records saved for each query.", "default": 20 }, "countryCode": { "title": "Google country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google country code used for localized Shopping results.", "default": "us" }, "languageCode": { "title": "Google language", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z]{2})?$", "type": "string", "description": "Google interface language code.", "default": "en" }, "gl": { "title": "Country alias", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Optional gl alias for countryCode." }, "hl": { "title": "Language alias", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z]{2})?$", "type": "string", "description": "Optional hl alias for languageCode." }, "renderJavaScript": { "title": "Render Shopping page", "type": "boolean", "description": "Use a normal Chromium page when a direct HTML request does not expose usable cards.", "default": true }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 10, "maximum": 90, "type": "integer", "description": "Per-request timeout in seconds.", "default": 30 }, "browserWaitMs": { "title": "Browser wait", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Milliseconds to allow the rendered page to populate.", "default": 2500 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Additional direct-request attempts after a transient failure.", "default": 1 }, "startUrls": { "title": "Google Shopping URLs", "maxItems": 20, "type": "array", "description": "Optional Google Shopping search URLs. Each URL must include a query and Shopping mode.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Google Shopping search URL." } }, "required": [ "url" ], "additionalProperties": false } }, "page": { "title": "Page", "minimum": 1, "type": "integer", "description": "One-based starting page or offset page for paginated sources.", "default": 1 }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of business records to emit.", "default": 25 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of source pages to inspect.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy for both HTTP and ordinary browser requests. Existing Residential pools are recommended. GOOGLE_SERP supports static Shopping HTML only; use renderJavaScript=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 }, "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 } } } } } } } } } }