{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper", "description": "Scrape AliExpress products, prices, reviews, variants and sellers by search keyword or product URL.", "version": "1.0", "x-build-id": "ZuPBMlTcOcKMIAgiN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unfenced-group~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unfenced-group-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/unfenced-group~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-unfenced-group-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/unfenced-group~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-unfenced-group-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search on AliExpress. Each query is paginated until maxResults is reached. Example: [\"wireless headphones\", \"phone case\"].", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct AliExpress product URLs (/item/.html) or search/category URLs. Product URLs are added directly; search URLs are paginated.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max products", "minimum": 0, "type": "integer", "description": "Maximum number of products to return per run. Set to 0 for unlimited (use with care).", "default": 5 }, "sortBy": { "title": "Sort products", "enum": [ "default", "priceAsc", "priceDesc", "orders", "newest" ], "type": "string", "description": "Sort order applied to product search results.", "default": "default" }, "includeReviews": { "title": "Include reviews (premium)", "type": "boolean", "description": "Fetch customer reviews for each product. Reviews are a premium feature billed separately per review. Each review includes rating, text, date, buyer name and country, helpful votes, aspect tags, shipping method, photos and more.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": -1, "type": "integer", "description": "Cap on reviews fetched per product. Set to 0 or -1 for all available reviews (AliExpress caps at ~5,000 per product).", "default": 20 }, "reviewStarFilter": { "title": "Review star filter", "enum": [ "all", "5", "4", "3", "2", "1" ], "type": "string", "description": "Only fetch reviews with this star rating.", "default": "all" }, "reviewImagesOnly": { "title": "Reviews with photos only", "type": "boolean", "description": "Only fetch reviews that include buyer photos. Overrides the star filter.", "default": false }, "reviewSort": { "title": "Review sort order", "enum": [ "relevant", "latest", "helpful" ], "type": "string", "description": "How to sort reviews before fetching.", "default": "relevant" }, "reviewOutputMode": { "title": "Review output mode", "enum": [ "nested", "separate" ], "type": "string", "description": "How reviews appear in the dataset. 'Nested' keeps reviews inside each product row. 'Separate' outputs one row per review (better for large review exports and analysis).", "default": "nested" }, "translateReviews": { "title": "Translate reviews", "type": "boolean", "description": "Translate each review into a target language. The original text is always kept alongside the translation.", "default": false }, "translateTo": { "title": "Translate reviews to", "enum": [ "en_US", "es_ES", "de_DE", "fr_FR", "it_IT", "pt_BR", "nl_NL", "ru_RU", "pl_PL", "tr_TR", "ar_MA", "ja_JP", "ko_KR", "zh_CN", "id_ID", "th_TH" ], "type": "string", "description": "Target language for review translation (when 'Translate reviews' is on).", "default": "en_US" }, "convertCurrencies": { "title": "Add USD & EUR price columns", "type": "boolean", "description": "Add salePriceUSD, salePriceEUR (and original-price equivalents) to every product using live exchange rates. AliExpress localises prices by region; these columns give a consistent cross-currency reference.", "default": true }, "minPrice": { "title": "Minimum price (USD)", "minimum": 0, "type": "integer", "description": "Only return products at or above this price in USD. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price (USD)", "minimum": 0, "type": "integer", "description": "Only return products at or below this price in USD. 0 = no maximum.", "default": 0 }, "proxyCountry": { "title": "Proxy country", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BR", "AU", "CA" ], "type": "string", "description": "Residential proxy exit country (ISO code). Affects prices and currency shown. US is the default and most reliable.", "default": "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 } } }, "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 } } } } } } } } } }