{
"openapi": "3.0.1",
"info": {
"title": "Google Shopping",
"description": "High-quality Google Shopping Scraper. Rich data results.",
"version": "0.0",
"x-build-id": "zEjElFo3MAj1xYYT6"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/dan.scraper~google-shopping/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-dan.scraper-google-shopping",
"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/dan.scraper~google-shopping/runs": {
"post": {
"operationId": "runs-sync-dan.scraper-google-shopping",
"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/dan.scraper~google-shopping/run-sync": {
"post": {
"operationId": "run-sync-dan.scraper-google-shopping",
"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",
"type": "array",
"description": "List of Google Shopping search query.",
"items": {
"type": "string"
}
},
"locationUule": {
"title": "Search Location - UULE location code",
"type": "string",
"description": "The code for geolocation of search results. It's passed to Google Search as the uule URL query parameter. You can use the UULE code generator. Learn more about emulating local search.
Notice: This parameter is the ONLY way to get Google Shopping results from a specific location."
},
"maxPagesPerQuery": {
"title": "Max pages per query",
"minimum": 1,
"type": "integer",
"description": "The maximum number of search result pages crawled for each search query or URL."
},
"countryCode": {
"title": "Country",
"enum": [
"",
"af",
"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",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cg",
"cd",
"ck",
"cr",
"ci",
"hr",
"cu",
"cy",
"cz",
"dk",
"dj",
"dm",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"tf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gn",
"gw",
"gy",
"ht",
"hm",
"va",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"il",
"it",
"jm",
"jp",
"jo",
"kz",
"ke",
"ki",
"kp",
"kr",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"nl",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"kn",
"lc",
"pm",
"vc",
"ws",
"sm",
"st",
"sa",
"sn",
"cs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"es",
"lk",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"tw",
"tj",
"tz",
"th",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"ug",
"ua",
"ae",
"gb",
"us",
"um",
"uy",
"uz",
"vu",
"ve",
"vn",
"vg",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw"
],
"type": "string",
"description": "This param is for the Country (e.g. es for Spain). The values must be lower-cased ISO 3166 country codes supported by Google. By default, the actor uses United States (us).
Notice: To get Google Shopping results from a location, please use UULE code. If you choose countryCode as es without setting locationUule, you will get the results from United States(default search location). To get results from Spain, you need to set locationUule to w+CAIQICIFU3BhaW4="
},
"languageCode": {
"title": "Language",
"enum": [
"",
"af",
"sq",
"sm",
"ar",
"az",
"eu",
"be",
"bn",
"bh",
"bs",
"bg",
"ca",
"zh-CN",
"zh-TW",
"hr",
"cs",
"da",
"nl",
"en",
"eo",
"et",
"fo",
"fi",
"fr",
"fy",
"gl",
"ka",
"de",
"el",
"gu",
"iw",
"hi",
"hu",
"is",
"id",
"ia",
"ga",
"it",
"ja",
"jw",
"kn",
"ko",
"la",
"lv",
"lt",
"mk",
"ms",
"ml",
"mt",
"mr",
"ne",
"no",
"nn",
"oc",
"fa",
"pl",
"pt-BR",
"pt-PT",
"pa",
"ro",
"ru",
"gd",
"sr",
"si",
"sk",
"sl",
"es",
"su",
"sw",
"sv",
"tl",
"ta",
"te",
"th",
"ti",
"tr",
"uk",
"ur",
"uz",
"vi",
"cy",
"xh",
"zu"
],
"type": "string",
"description": "Language for the search results, which is passed to Google Search as the hl URL query parameter. Only set this if you want to use a non-default language for the selected country. The values must be lower-cased ISO 639 language codes supported by Google.",
"default": ""
},
"googleDomain": {
"title": "Google Domain",
"enum": [
"",
"google.ad",
"google.ae",
"google.com.af",
"google.com.ag",
"google.com.ai",
"google.al",
"google.am",
"google.co.ao",
"google.com.ar",
"google.as",
"google.at",
"google.com.au",
"google.az",
"google.ba",
"google.com.bd",
"google.be",
"google.bf",
"google.bg",
"google.com.bh",
"google.bi",
"google.bj",
"google.com.bn",
"google.com.bo",
"google.com.br",
"google.bs",
"google.bt",
"google.co.bw",
"google.by",
"google.com.bz",
"google.ca",
"google.com.kh",
"google.cd",
"google.cf",
"google.cg",
"google.ch",
"google.ci",
"google.co.ck",
"google.cl",
"google.cm",
"google.com.co",
"google.co.cr",
"google.com.cu",
"google.cv",
"google.com.cy",
"google.cz",
"google.de",
"google.dj",
"google.dk",
"google.dm",
"google.com.do",
"google.dz",
"google.com.ec",
"google.ee",
"google.com.eg",
"google.es",
"google.com.et",
"google.fi",
"google.fm",
"google.com.fj",
"google.fr",
"google.ga",
"google.ge",
"google.com.gh",
"google.com.gi",
"google.gl",
"google.gm",
"google.gp",
"google.gr",
"google.com.gt",
"google.gy",
"google.com.hk",
"google.hn",
"google.hr",
"google.ht",
"google.hu",
"google.co.id",
"google.iq",
"google.ie",
"google.co.il",
"google.co.in",
"google.is",
"google.it",
"google.je",
"google.com.jm",
"google.jo",
"google.co.jp",
"google.co.ke",
"google.ki",
"google.kg",
"google.co.kr",
"google.com.kw",
"google.kz",
"google.la",
"google.com.lb",
"google.li",
"google.lk",
"google.co.ls",
"google.lt",
"google.lu",
"google.lv",
"google.com.ly",
"google.co.ma",
"google.md",
"google.mg",
"google.mk",
"google.ml",
"google.com.mm",
"google.mn",
"google.ms",
"google.com.mt",
"google.mu",
"google.mv",
"google.mw",
"google.com.mx",
"google.com.my",
"google.co.mz",
"google.com.na",
"google.ne",
"google.com.ng",
"google.com.ni",
"google.nl",
"google.no",
"google.com.np",
"google.nr",
"google.nu",
"google.co.nz",
"google.com.om",
"google.com.pk",
"google.com.pa",
"google.com.pe",
"google.com.ph",
"google.pl",
"google.com.pg",
"google.com.pr",
"google.ps",
"google.pt",
"google.com.py",
"google.com.qa",
"google.ro",
"google.rs",
"google.ru",
"google.rw",
"google.com.sa",
"google.com.sb",
"google.sc",
"google.se",
"google.com.sg",
"google.sh",
"google.si",
"google.sk",
"google.com.sl",
"google.sn",
"google.sm",
"google.so",
"google.sr",
"google.com.sv",
"google.td",
"google.tg",
"google.co.th",
"google.com.tj",
"google.tk",
"google.tl",
"google.tm",
"google.to",
"google.tn",
"google.com.tr",
"google.tt",
"google.com.tw",
"google.co.tz",
"google.com.ua",
"google.co.ug",
"google.co.uk",
"google.com.uy",
"google.co.uz",
"google.com.vc",
"google.co.ve",
"google.vg",
"google.co.vi",
"google.com.vn",
"google.vu",
"google.ws",
"google.co.za",
"google.co.zm",
"google.co.zw"
],
"type": "string",
"description": "This param is for the Google Search Domain (e.g. google.es for Spain). By default, the actor uses United States (google.com).
Notice: To get Google Shopping results from a location, please use UULE code. If you choose googleDomain as google.es without setting locationUule, you will get the results from United States(default search location). To get results from Spain, you need to set locationUule to w+CAIQICIFU3BhaW4="
},
"filterValue": {
"title": "Filter or sort results by categories",
"type": "string",
"description": "Input filterValue to filter Google Shopping results by price, band... The filterValue can be found in shopping results response. To apply multiple filters, you can try one filter first, then check the response and find the following filters."
},
"device": {
"title": "Device",
"enum": [
"desktop",
"mobile",
"tablet"
],
"type": "string",
"description": "Device can be \"desktop\", \"mobile\" or \"tablet.",
"default": "desktop"
},
"csvFriendlyOutput": {
"title": "Output CSV friendly format",
"type": "boolean",
"description": "Include shopping results data, use for CSV format"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}