{ "openapi": "3.0.1", "info": { "title": "AliExpress Reviews Scraper & New Review Monitor", "description": "Scrape AliExpress reviews from product links or a search keyword: stars, date, text with translation, buyer country, variant and photos. Filter by date, stars and words, or get only new reviews on a schedule. Buyer names are left out.", "version": "0.1", "x-build-id": "LZgNJtt18BRzEIoNV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zerolag~aliexpress-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zerolag-aliexpress-reviews-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/zerolag~aliexpress-reviews-scraper/runs": { "post": { "operationId": "runs-sync-zerolag-aliexpress-reviews-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/zerolag~aliexpress-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-zerolag-aliexpress-reviews-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 links or ids", "type": "array", "description": "AliExpress product links or numeric product ids, one per line. Links from country sites such as aliexpress.us or pt.aliexpress.com work too. Use this, Search keywords, or both.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "The Actor searches AliExpress for each keyword and reads the reviews of the products it finds, in the same run. Example: wireless earbuds. Use this, Product links or ids, or both.", "items": { "type": "string" } }, "maxProductsPerKeyword": { "title": "Products per keyword", "minimum": 1, "type": "integer", "description": "How many products to take from the search results of each keyword.", "default": 10 }, "searchSort": { "title": "Search order", "enum": [ "orders", "best_match" ], "type": "string", "description": "Which products a keyword finds first. Most orders finds products that have reviews. Best match follows the AliExpress default.", "default": "orders" }, "reviewsSince": { "title": "Reviews since", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Keep only reviews from this day on. Pick a date or a period such as 30 days. Empty means no date limit." }, "minRating": { "title": "Minimum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at least this many stars, from 1 to 5." }, "maxRating": { "title": "Maximum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at most this many stars, from 1 to 5. Set 2 to get complaints only." }, "reviewType": { "title": "Review type", "enum": [ "all", "with_photos", "with_follow_up" ], "type": "string", "description": "With photos and With follow-up use the AliExpress filters.", "default": "all" }, "onlyWithText": { "title": "Only reviews with text", "type": "boolean", "description": "Skip reviews that are only a star rating. Many AliExpress reviews have no text, so this saves money when you read what buyers wrote.", "default": false }, "textContains": { "title": "Review text contains", "type": "array", "description": "Keep reviews that mention at least one of these words. Case does not matter. The Actor looks in the original text, the translation and the follow-up.", "default": [], "items": { "type": "string" } }, "countries": { "title": "Buyer countries", "type": "array", "description": "Keep reviews from these countries. Two-letter codes such as US, BR or ES. The Actor then reads the AliExpress list of each country, which also reaches reviews missing from the main list of a large product.", "default": [], "items": { "type": "string" } }, "excludeSimilarItems": { "title": "Skip reviews of similar items", "type": "boolean", "description": "Some listings mix in reviews that AliExpress labels as a review for a similar item. Turn this on to keep only reviews of the listing itself.", "default": false }, "onlyNewReviews": { "title": "Only new reviews", "type": "boolean", "description": "For scheduled runs. The first run saves your baseline. Every later run saves and charges only reviews it has not seen before.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate memory for each list of products. Use a different name for each schedule, or a new name to start over. Letters, numbers and hyphens.", "default": "default" }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 0, "type": "integer", "description": "The most reviews to save from one product. 0 means all reviews.", "default": 100 }, "maxReviews": { "title": "Reviews per run", "minimum": 0, "type": "integer", "description": "The run stops after saving this many reviews in total. 0 means no limit.", "default": 1000 }, "sortBy": { "title": "Review order", "enum": [ "newest", "oldest", "lowest_rating", "highest_rating", "aliexpress" ], "type": "string", "description": "AliExpress ignores sorting, so the Actor reads all reviews of a product and sorts them itself. AliExpress order is the fastest choice when you need only a few reviews from each product.", "default": "newest" }, "language": { "title": "Translation language", "enum": [ "en_US", "es_ES", "pt_BR", "fr_FR", "de_DE", "it_IT", "nl_NL", "pl_PL", "tr_TR", "ru_RU", "ja_JP", "ko_KR", "ar_MA", "he_IL", "id_ID", "th_TH" ], "type": "string", "description": "Language of the translated text and the variant names. AliExpress does the translating. The original text is always included.", "default": "en_US" } } }, "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 } } } } } } } } } }