{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper: Products, Prices & Reviews", "description": "Scrape AliExpress search results (price, sale price, orders sold, rating, images, shipping) and buyer reviews (stars, text, photos, country, SKU). Keywords, search URLs or product IDs. No login.", "version": "0.1", "x-build-id": "Xamy6HieprrNfbsrs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cprussin~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cprussin-aliexpress-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/cprussin~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-cprussin-aliexpress-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/cprussin~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-cprussin-aliexpress-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "What to search for on AliExpress, one search per keyword (e.g. \"wireless earbuds\", \"phone case\"). Each result page has about 60 products.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Optional. AliExpress search or category result URLs, with any filters you set on the site, e.g. https://www.aliexpress.com/w/wholesale-phone-case.html?SortType=total_tranpro_desc. Not product pages (put those in Product IDs).", "items": { "type": "string" } }, "maxPagesPerKeyword": { "title": "Max pages per search", "minimum": 1, "maximum": 60, "type": "integer", "description": "Result pages to read per keyword / search URL (about 60 products per page; AliExpress stops at 60 pages).", "default": 1 }, "sort": { "title": "Sort by", "enum": [ "default", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "Result order. Ignored for search URLs that already contain a SortType.", "default": "default" }, "includeReviews": { "title": "Scrape reviews for search results", "type": "boolean", "description": "Also fetch buyer reviews for the top products of each search (see \"Reviews for top N products\").", "default": true }, "reviewsForTopProducts": { "title": "Reviews for top N products", "minimum": 0, "type": "integer", "description": "Fetch reviews for the first N products of each search. 0 = every product found.", "default": 3 }, "productIds": { "title": "Product IDs or URLs (reviews only)", "type": "array", "description": "Optional. Products to fetch reviews for, without searching: item IDs (1005007502032342) or item URLs (https://www.aliexpress.com/item/1005007502032342.html).", "items": { "type": "string" } }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many reviews per product (20 per request).", "default": 10 }, "translateReviews": { "title": "Translate reviews", "type": "boolean", "description": "Ask AliExpress for machine translations into the Language below (returned in translatedText). AliExpress then prefers reviews from buyers in the ship-to country, and dates may be localized.", "default": false }, "shipTo": { "title": "Ship to country", "type": "string", "description": "Two-letter country code (US, GB, DE, FR, BR, ...). Prices, availability and delivery estimates depend on it. EU/UK searches return fewer fields (no rating or sold count) because AliExpress shows lean cards there.", "default": "US" }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency code for prices (USD, EUR, GBP, BRL, ...).", "default": "USD" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language for titles and review translations (en, de, fr, es, pt, ...).", "default": "en" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. By default the actor connects directly and switches to Apify datacenter proxy automatically if AliExpress starts blocking. Set a proxy here to always use it.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }