{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper", "description": "The Amazon Search Results Scraper lets you extract product data directly from Amazon search results. Collect titles, prices, ratings, ASINs, URLs, and more at scale. Ideal for market research, competitor analysis, and e-commerce insights. Fast, accurate, and customizable scraping solution.", "version": "0.1", "x-build-id": "BVfbXTBv9daSNRwFv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-amazon-search-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/scraper-engine~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-amazon-search-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/scraper-engine~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-amazon-search-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", "required": [ "urls" ], "properties": { "urls": { "title": "🔗 Keywords or Amazon search URLs", "type": "array", "description": "One entry per search. Plain keywords run on amazon.com. Paste a country search URL (for example https://www.amazon.co.uk/s?k=running+shoes) to search that marketplace instead. Supported marketplaces: .com, .co.uk, .de, .fr, .it, .es, .ca", "items": { "type": "string" } }, "maxResults": { "title": "📦 Products per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of products to collect FOR EACH keyword or URL you entered. Two keywords with a limit of 25 return up to 50 products in total. The actor stops early when Amazon has no more results for that keyword.", "default": 10 }, "sortBy": { "title": "↕️ Result order", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "The result order Amazon applies before the products are collected. Each row reports back the order Amazon actually used, so you can always confirm it.", "default": "relevanceblender" }, "category": { "title": "🗂️ Department", "enum": [ "aps", "electronics", "computers", "office-products", "fashion", "shoes", "beauty", "hpc", "grocery", "kitchen", "garden", "lawngarden", "tools", "appliances", "automotive", "industrial", "pets", "baby-products", "toys-and-games", "videogames", "sporting", "stripbooks", "movies-tv", "digital-music", "mi" ], "type": "string", "description": "Limit all searches to a single Amazon department. Leave on 'All departments' to search the whole catalogue. When a department is selected, each row also reports the department facets and the selected department path.", "default": "aps" }, "browseNode": { "title": "🔢 Category node ID", "type": "string", "description": "Optional. An exact Amazon category node ID (for example 172282) to scope every search to that category. Leave empty unless you already know the node you want. A node ID pasted inside a search URL is picked up automatically." }, "proxyConfiguration": { "title": "🌐 Connection settings", "type": "object", "description": "Controls how the actor reaches Amazon. The preselected option is the one that works reliably for Amazon search pages, and the actor matches the connection country to the marketplace you are searching.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }