{ "openapi": "3.0.1", "info": { "title": "Google Shopping Scraper — Prices, Sellers & Offers", "description": "Google Shopping scraper: products, prices, old prices, sellers & all store offers for price comparison, ratings, reviews, delivery. Any country.", "version": "1.0", "x-build-id": "S12omwYf3jdtowoT7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cheapapi~google-shopping-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cheapapi-google-shopping-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/cheapapi~google-shopping-scraper/runs": { "post": { "operationId": "runs-sync-cheapapi-google-shopping-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/cheapapi~google-shopping-scraper/run-sync": { "post": { "operationId": "run-sync-cheapapi-google-shopping-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": { "mode": { "title": "What to scrape", "enum": [ "search", "offers", "details" ], "type": "string", "description": "Products from a search: one row per product Google Shopping shows for your search terms. Seller offers: one row per store selling a product (price, shipping, total price, condition). Product details: one row per product with description, images, specifications and its sellers.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What you would type into Google Shopping, one per line. Used by the Products from a search mode.", "items": { "type": "string" } }, "products": { "title": "Product links or IDs", "type": "array", "description": "Used only in the Seller offers and Product details modes (ignored in search mode): Google Shopping product links (copy the address of an opened product) or product IDs, one per line, e.g. 4485466949985702538. Tip: the productId column of a search run works directly. Also accepted: gid:123… and docid:123….", "items": { "type": "string" } }, "maxProductsPerSearch": { "title": "Products per search", "minimum": 1, "maximum": 120, "type": "integer", "description": "Maximum products to collect for each search term (Google shows about 40 per page; up to 120). You pay per product delivered. Each search has a minimum charge of $0.0028 (+$0.0025 per further started block of 40 results Google returns): a search that delivers less (e.g. 0 products, or 1 product with this set to 1) is topped up to it (lookup-minimum, see Pricing).", "default": 40 }, "country": { "title": "Country", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "BQ", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TM", "TC", "TV", "TR", "UM", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "Country to shop in — prices, stores and currency follow it.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language code for Google Shopping, e.g. en, de, fr, pt-BR.", "default": "en" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "rating", "priceLowToHigh", "priceHighToLow" ], "type": "string", "description": "Order of the products in the search results.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only products priced at or above this amount (whole number, in the local currency of the chosen country)." }, "maxPrice": { "title": "Maximum price", "minimum": 1, "type": "integer", "description": "Only products priced at or below this amount (whole number, in the local currency)." }, "maxPages": { "title": "Result pages to load", "minimum": 1, "maximum": 7, "type": "integer", "description": "Optional. How many Google Shopping result pages to load per search (1–7). Normally not needed — “Products per search” controls the depth." }, "includeSponsored": { "title": "Include sponsored products and ads", "type": "boolean", "description": "Also return products from sponsored carousels and shopping ads (marked isSponsored: true). Each one counts as a product.", "default": false }, "includeCarousels": { "title": "Include product carousels", "type": "boolean", "description": "Also return products from Google’s extra carousels on the results page (e.g. deals, popular products). Each one counts as a product.", "default": false }, "searchUrls": { "title": "Google Shopping search URLs", "type": "array", "description": "Instead of search terms, paste Google Shopping search URLs (with any filters already applied in the browser). Search terms are read from the q parameter.", "items": { "type": "string" } }, "extraUrlParameters": { "title": "Extra Google URL parameters", "type": "string", "description": "Raw Google Shopping URL parameters for any filter Google offers, e.g. &tbs=mr:1,sales:1 (on sale). For experts." }, "offersForTopProducts": { "title": "Seller offers for the first N products of each search", "minimum": 0, "maximum": 120, "type": "integer", "description": "Products from a search mode only: also collect all seller offers for the first N products of every search (0 = off). Offers are billed as in the Seller offers mode.", "default": 0 }, "maxOffersPerProduct": { "title": "Offers per product", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum seller offers to collect per product (up to 200). You pay per offer delivered. Each product's offers lookup has a minimum charge of $0.0028 for up to 10 offers Google returns, +$0.0025 per further started block of 10 (each block counts twice with “Buy on Google” offers): a lookup that delivers less (no offers, or all prices unchanged) is topped up to it (lookup-minimum, see Pricing).", "default": 20 }, "includeBuyOnGoogle": { "title": "Include “Buy on Google” offers", "type": "boolean", "description": "Also check offers sold directly through Google checkout. Adds an add-on charge per started block of 10 delivered offers and doubles the offers lookup minimum (see Pricing).", "default": false }, "variantFilter": { "title": "Product variant filter", "type": "string", "description": "Optional Google product-variant filter value (the pvf value from a Google Shopping product URL) to get offers for one exact variant, e.g. a size or color." }, "productSpecifications": { "title": "Product variant specifications", "type": "object", "description": "Optional. Variant details to match for products given as links or IDs, e.g. {\"Color\": \"Black\", \"Storage\": \"256 GB\"}. For products found by a search this is filled in automatically." }, "location": { "title": "City or region", "type": "string", "description": "Shop from a specific place instead of the whole country, written as City,Region,Country, e.g. Austin,Texas,United States. Overrides Country." }, "coordinates": { "title": "Coordinates", "pattern": "^\\s*-?\\d+(\\.\\d+)?\\s*,\\s*-?\\d+(\\.\\d+)?(\\s*,\\s*\\d+(\\.\\d+)?)?\\s*$", "type": "string", "description": "Shop from an exact point: latitude,longitude or latitude,longitude,radius-in-meters (radius 200–199999). Overrides City and Country." }, "googleDomain": { "title": "Google domain", "type": "string", "description": "Optional Google domain, e.g. google.co.uk, google.de. Default: chosen automatically." }, "monitorPrices": { "title": "Track price changes between runs", "type": "boolean", "description": "Remembers the last price of every product and seller offer (per monitoring name, country and language) and adds previousPrice, priceChange, priceChangePct, isNew and priceStatus to each row. Schedule the same input daily to monitor prices. Tracking alone has no extra charge.", "default": false }, "onlyChangedPrices": { "title": "Only deliver new or changed prices", "type": "boolean", "description": "Deliver only rows that are new or whose price changed since the last run. Unchanged rows are not delivered and not charged; each search or product lookup that returned data costs a $0.004 price check instead (plus a lookup-minimum top-up when a lookup with many unchanged results stays below its minimum charge, see Pricing). Turns on price tracking automatically. The first run delivers everything (all rows are new).", "default": false }, "monitoringName": { "title": "Monitoring name", "type": "string", "description": "Each name keeps its own price history. Use one name per list you monitor (e.g. headphones-us) so separate schedules do not affect each other. Max 100 characters.", "default": "default" }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Smaller price moves count as unchanged (0 = any change). The last reported price is kept, so small moves that add up to this threshold are still reported.", "default": 0 }, "processingSpeed": { "title": "Processing speed", "enum": [ "auto", "fast", "economy" ], "type": "string", "description": "How quickly results are collected. The price is the same; economy is meant for large batches.", "default": "auto" }, "maxWaitMinutes": { "title": "Maximum wait (minutes)", "minimum": 1, "maximum": 600, "type": "integer", "description": "Requests not finished after this time are reported in the run summary. They were already sent and are billed to us, so each one is charged only its lookup minimum ($0.0028; $0.0053 for offers with “Buy on Google”), no rows.", "default": 60 } } }, "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 } } } } } } } } } }