{ "openapi": "3.0.1", "info": { "title": "Google Shopping API | Google Shopping Products, Prices & Deals", "description": "Scrape Google Shopping results: extract product listings, prices, ratings, sellers, delivery info, and discount tags. Filter by location, price range, sort order, free shipping, and sale items. Supports multi-page scraping. Extract product listings, prices, ratings, sellers, and delivery info.", "version": "0.0", "x-build-id": "0yuFw7pdS9axy2O3z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnvc~google-shopping-api-google-shopping-products-prices-deals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnvc-google-shopping-api-google-shopping-products-prices-deals", "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/johnvc~google-shopping-api-google-shopping-products-prices-deals/runs": { "post": { "operationId": "runs-sync-johnvc-google-shopping-api-google-shopping-products-prices-deals", "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/johnvc~google-shopping-api-google-shopping-products-prices-deals/run-sync": { "post": { "operationId": "run-sync-johnvc-google-shopping-api-google-shopping-products-prices-deals", "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": [ "q" ], "properties": { "q": { "title": "Search Query", "type": "string", "description": "The product or keyword to search for on Google Shopping. Example: 'wireless headphones', 'iPhone 15 case'." }, "location": { "title": "Location", "type": "string", "description": "Geographic location to localize the search results. Example: 'Austin, Texas, United States', 'London, England, United Kingdom'." }, "gl": { "title": "Country Code (gl)", "type": "string", "description": "Two-letter country code for Google to use. Examples: 'us', 'uk', 'de', 'fr', 'ca', 'au'." }, "hl": { "title": "Language Code (hl)", "type": "string", "description": "Two-letter language code for results. Examples: 'en', 'es', 'de', 'fr', 'ja'." }, "google_domain": { "title": "Google Domain", "type": "string", "description": "Google domain to use for the search. Defaults to 'google.com'. Examples: 'google.co.uk', 'google.de', 'google.fr'." }, "device": { "title": "Device Type", "enum": [ "desktop", "tablet", "mobile" ], "type": "string", "description": "Device type to simulate. Different devices may return slightly different results and prices.", "default": "desktop" }, "min_price": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Filter results to only show products above this price (in the local currency)." }, "max_price": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Filter results to only show products below this price (in the local currency)." }, "sort_by": { "title": "Sort Order", "minimum": 1, "maximum": 2, "type": "integer", "description": "Sort results by price. 1 = price low to high, 2 = price high to low. Leave blank for default relevance sorting." }, "free_shipping": { "title": "Free Shipping Only", "type": "boolean", "description": "When enabled, only return products that offer free shipping.", "default": false }, "on_sale": { "title": "On Sale Only", "type": "boolean", "description": "When enabled, only return products that are currently on sale or have a discount.", "default": false }, "max_pages": { "title": "Max Pages", "minimum": 0, "type": "integer", "description": "Maximum number of result pages to fetch. Each page contains approximately 40 products. Set to 0 for no limit (fetches all available pages). Default is 1.", "default": 1 }, "output_file": { "title": "Output File Name", "type": "string", "description": "Optional filename for saving results as a JSON file locally. If not provided, a timestamped filename is generated automatically." } } }, "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 } } } } } } } } } }