{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper: Amazon, TikTok Shop, Shopee, Temu", "description": "All-in-one e-commerce scraper: product data, prices, images, specs, rating and buyer reviews from Amazon, TikTok Shop, Shopee, Lazada, AliExpress, Temu, Walmart, Etsy, eBay, Shein, Taobao, 1688 and Shopify stores. One JSON format. First 10 free.", "version": "0.1", "x-build-id": "ZY1IlR7Ufaan8gpFA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omnipotent_stairway~ecommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omnipotent_stairway-ecommerce-product-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/omnipotent_stairway~ecommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-omnipotent_stairway-ecommerce-product-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/omnipotent_stairway~ecommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-omnipotent_stairway-ecommerce-product-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": { "productUrls": { "title": "Product URLs", "type": "array", "description": "Product page links from Amazon, TikTok Shop, AliExpress, Temu, Shopee, Lazada, Walmart, Etsy, eBay, Shein, Taobao/Tmall, 1688, Alibaba.com or any Shopify store (mix freely, up to 500). One product with rating and buyer reviews per link. First 10 results free.", "items": { "type": "string" } }, "includeAllReviews": { "title": "Also get all reviews (not just 5 quotes)", "type": "boolean", "description": "For each product link, also return up to the number below of individual reviews (negative ones too) with stars, date, text, variant and photos. Amazon, TikTok Shop, AliExpress, Walmart, Lazada, Etsy, Shopee and 1688. Charged per review.", "default": false }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 500, "type": "integer", "description": "Amazon returns at most 100 (most recent first).", "default": 50 }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Search the marketplaces below for these keywords (up to 20). Returns the top results with price, rating, sales and link.", "items": { "type": "string" } }, "searchMarketplaces": { "title": "Marketplaces to search", "type": "array", "description": "Where to search. Defaults to Amazon.", "items": { "type": "string", "enum": [ "amazon", "tiktok", "aliexpress", "temu", "ebay", "ebay-sold", "walmart", "etsy", "shopee", "lazada", "shein", "naver", "mercadolibre", "fbmarketplace" ], "enumTitles": [ "Amazon", "TikTok Shop", "AliExpress", "Temu", "eBay", "eBay sold listings", "Walmart", "Etsy", "Shopee", "Lazada", "Shein", "Naver (Korea)", "Mercado Libre / Livre", "Facebook Marketplace" ] }, "default": [ "amazon" ] }, "searchCountry": { "title": "Country", "type": "string", "description": "Two-letter country site, e.g. US, GB, DE, JP (Amazon, eBay), MY, PH, TH (Shopee, Lazada). TikTok Shop: US only. Empty = each marketplace's main site.", "default": "" }, "searchLocation": { "title": "City (Facebook Marketplace)", "type": "string", "description": "Facebook Marketplace searches are local: the city to search around, e.g. Los Angeles.", "default": "" }, "maxResultsPerSearch": { "title": "Results per keyword and marketplace", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many top results to return for each keyword on each marketplace (1-100).", "default": 20 }, "searchImages": { "title": "Product photos", "type": "array", "description": "Public https links to product photos (up to 20). Find the same product for sale across the web, on Amazon, or its supply on 1688 / AliExpress.", "items": { "type": "string" } }, "imageSearchTargets": { "title": "Where to look", "type": "array", "description": "Web = the same product at other stores with prices (Google Lens). Amazon = Amazon's matching items. 1688 / AliExpress = same-style supply and sourcing prices.", "items": { "type": "string", "enum": [ "web", "amazon", "1688", "aliexpress" ], "enumTitles": [ "Same product across the web", "Amazon", "1688 (supply)", "AliExpress (supply)" ] }, "default": [ "web" ] } } }, "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 } } } } } } } } } }