{ "openapi": "3.0.1", "info": { "title": "AliExpress Multi-Region Search, Store & Review Scraper", "description": "Search AliExpress or fetch product, store, and review records by ID or URL across 18 regional storefronts and 42 currencies, with price, rating, and ship-from/ship-to filters.", "version": "1.0", "x-build-id": "BqmW8MdoJaOgZceAU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~aliexpress-multi-region-search-store-and-review/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-aliexpress-multi-region-search-store-and-review", "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/vexaloom-labs~aliexpress-multi-region-search-store-and-review/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-aliexpress-multi-region-search-store-and-review", "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/vexaloom-labs~aliexpress-multi-region-search-store-and-review/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-aliexpress-multi-region-search-store-and-review", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byProduct", "byStore", "byReviews", "byUrl" ], "type": "string", "description": "What to collect. search: keyword results. byProduct: product lookup by ID or URL. byStore: store lookup. byReviews: customer reviews. byUrl: auto-detect from pasted AliExpress links.", "default": "search" }, "searchQueries": { "title": "Search queries (mode=search)", "type": "array", "description": "One or more keywords, e.g. \"phone case\" or \"wireless earbuds\". Each query is scraped up to maxPages pages.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs or URLs (mode=byProduct or byReviews)", "type": "array", "description": "Numeric AliExpress product IDs or item URLs. Both 1005… and 3256… ID formats are accepted.", "items": { "type": "string" } }, "storeIds": { "title": "Store IDs or URLs (mode=byStore)", "type": "array", "description": "Numeric store IDs or /store/… URLs.", "items": { "type": "string" } }, "urls": { "title": "AliExpress URLs (mode=byUrl)", "type": "array", "description": "Any mix of search, item, store and review URLs. The mode is detected per URL.", "items": { "type": "string" } }, "region": { "title": "Shopper region", "type": "string", "description": "Country used for prices, availability and the storefront locale. Global leaves the region to the requesting IP.", "default": "US" }, "currency": { "title": "Currency override", "enum": [ "", "USD", "EUR", "GBP", "JPY", "CNY", "RUB", "BRL", "INR", "AUD", "CAD", "HKD", "TWD", "KRW", "SGD", "MXN", "ARS", "CLP", "COP", "PEN", "UYU", "ILS", "TRY", "AED", "SAR", "ZAR", "PLN", "CHF", "SEK", "NOK", "DKK", "CZK", "HUF", "RON", "THB", "VND", "PHP", "IDR", "MYR", "NZD", "PKR", "EGP", "NGN" ], "type": "string", "description": "Optional ISO-4217 currency. Leave blank to use the region's usual currency. The currency actually returned is recorded in every record.", "default": "" }, "language": { "title": "Language", "enum": [ "en_US", "es_ES", "fr_FR", "de_DE", "it_IT", "pt_BR", "pt_PT", "ru_RU", "ja_JP", "ko_KR", "ar_MA", "tr_TR", "th_TH", "vi_VN", "id_ID", "nl_NL", "pl_PL", "iw_IL" ], "type": "string", "description": "Storefront language and the language used to translate review text.", "default": "en_US" }, "sortBy": { "title": "Sort order (mode=search)", "type": "string", "description": "How keyword results are ordered. AliExpress does not expose a newest sort.", "default": "default" }, "priceMin": { "title": "Minimum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Minimum price in the selected currency. 0 disables the lower bound.", "default": 0 }, "priceMax": { "title": "Maximum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Maximum price in the selected currency. 0 disables the upper bound.", "default": 0 }, "ratingMin": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Minimum star rating from 0 to 5. Products without a rating are skipped when a threshold is set.", "default": 0 }, "shipFrom": { "title": "Ship from country", "enum": [ "", "CN", "US", "RU", "ES", "FR", "DE", "IT", "GB", "PL", "TR", "BR", "JP", "KR", "AU", "CA", "MX", "AE", "SA", "IL", "TH", "VN", "ID", "MY", "NL", "BE", "PT" ], "type": "string", "description": "Only show items stocked in this country. Leave blank for any warehouse.", "default": "" }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only show items advertised with free shipping.", "default": false }, "choiceOnly": { "title": "AliExpress Choice only", "type": "boolean", "description": "Only show AliExpress Choice items.", "default": false }, "fourStarPlus": { "title": "4 stars and up only", "type": "boolean", "description": "Only show items rated 4.0 or higher. The actor enforces the 4.0 threshold after AliExpress returns its filtered page.", "default": false }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Include promoted product cards; they are marked isSponsored in the output.", "default": true }, "includeWelcomeGifts": { "title": "Include welcome-gift cards", "type": "boolean", "description": "Include $0.00 new-shopper gift cards; they are marked isWelcomeGift and have no normal price.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on records emitted by the run.", "default": 100 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 60, "type": "integer", "description": "Maximum result pages per query (60 products per page, up to 60 pages).", "default": 3 }, "includeReviews": { "title": "Attach reviews", "type": "boolean", "description": "Fetch customer reviews for each product (slow and adds records to the product).", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "maximum": 200, "type": "integer", "description": "Review cap per product when reviews are fetched. 0 uses the default of 20.", "default": 20 }, "reviewFilter": { "title": "Review filter", "enum": [ "all", "withPhotos", "additional" ], "type": "string", "description": "Which reviews to collect.", "default": "all" }, "includeProductStats": { "title": "Include review summary", "type": "boolean", "description": "Add each product's average rating and total review count to review records.", "default": true } } }, "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 } } } } } } } } } }