{ "openapi": "3.0.1", "info": { "title": "Aliexpress Product Scraper", "description": "Scrape AliExpress product listings by keyword with prices, ratings, seller info, reviews, and shipping details. Supports 30+ currencies and 40+ ship-to countries. Batch up to 50 queries per run with advanced filtering by price, rating, and order count.", "version": "1.0", "x-build-id": "vRBr8bOYsb2fDwzhk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skystone_labs~aliexpress-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skystone_labs-aliexpress-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/skystone_labs~aliexpress-product-scraper/runs": { "post": { "operationId": "runs-sync-skystone_labs-aliexpress-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/skystone_labs~aliexpress-product-scraper/run-sync": { "post": { "operationId": "run-sync-skystone_labs-aliexpress-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": { "queries": { "title": "Search Queries", "minItems": 0, "maxItems": 50, "type": "array", "description": "Keywords to search on AliExpress. Each query runs independently and returns up to maxPages of results. Example: [\"wireless earbuds\", \"phone cases\"].", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct AliExpress URLs to scrape. Supports product pages (aliexpress.com/item/...), category pages, and search result URLs. Use instead of or alongside queries.", "items": { "type": "string" } }, "maxPages": { "title": "Max Pages per Query", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many search result pages to scrape per query. Each page has ~40-60 products. Set to 1 for quick tests, up to 20 for comprehensive scraping.", "default": 5 }, "maxItems": { "title": "Max Products Total", "minimum": 0, "type": "integer", "description": "Stop scraping after this many products total across all queries. Set to 0 for unlimited. Useful for controlling costs on pay-per-event pricing.", "default": 0 }, "language": { "title": "Language", "enum": [ "en_US", "es_ES", "pt_BR", "fr_FR", "de_DE", "it_IT", "ru_RU", "nl_NL", "tr_TR", "ja_JP", "ko_KR", "th_TH", "vi_VN", "ar_SA", "he_IL", "pl_PL" ], "type": "string", "description": "Language for product titles and descriptions. Affects the locale of returned data.", "default": "en_US" }, "shipTo": { "title": "Ship To Country", "enum": [ "US", "GB", "AU", "CA", "DE", "FR", "ES", "IT", "NL", "BE", "RU", "BR", "MX", "JP", "KR", "SG", "MY", "TH", "VN", "PH", "ID", "IN", "AE", "SA", "TR", "PL", "CZ", "SE", "NO", "DK", "FI", "IE", "AT", "CH", "PT", "GR", "IL", "NZ", "ZA", "CL", "AR", "CO", "PE" ], "type": "string", "description": "Destination country for shipping prices and product availability. Prices and shipping options change based on this.", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "JPY", "KRW", "RUB", "BRL", "MXN", "INR", "SGD", "MYR", "THB", "VND", "PHP", "IDR", "AED", "SAR", "TRY", "PLN", "CZK", "SEK", "NOK", "DKK", "CHF", "NZD", "ZAR", "ILS", "CLP", "ARS", "COP", "PEN" ], "type": "string", "description": "Currency for all prices in the output. All price fields will use this currency.", "default": "USD" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Exclude products below this price (in the selected currency). Products with price < minPrice are filtered out before output." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Exclude products above this price (in the selected currency)." }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Exclude products with star rating below this value. Scale is 0-5." }, "minOrderCount": { "title": "Minimum Orders", "minimum": 0, "type": "integer", "description": "Exclude products with fewer total orders than this value. Useful for finding proven sellers." }, "shipsFrom": { "title": "Ships From Country", "enum": [ "Any", "CN", "US", "RU", "ES", "UK", "AU", "TR", "DE", "FR", "IT", "PL", "CZ" ], "type": "string", "description": "Only show products that ship from this warehouse location. 'Any' includes all warehouses.", "default": "Any" }, "sortBy": { "title": "Sort Results By", "enum": [ "default", "orders", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "description": "How AliExpress sorts search results before scraping.", "default": "default" }, "includeDescription": { "title": "Include Description", "type": "boolean", "description": "Extract full product description HTML. Only works for product detail pages (startUrls). Adds ~2s per product.", "default": false }, "includeVariants": { "title": "Include Variants", "type": "boolean", "description": "Extract color/size options with individual SKU pricing. Only available from product detail pages.", "default": false }, "includeShippingDetails": { "title": "Include Shipping Details", "type": "boolean", "description": "Include shipping cost, provider, and delivery estimates in output.", "default": true }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Extract customer reviews with ratings, text, and dates. Only from product detail pages. Adds ~3s per product.", "default": false }, "maxReviews": { "title": "Max Reviews per Product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum reviews to extract per product when includeReviews is true.", "default": 10 }, "includeQuestions": { "title": "Include Q&A", "type": "boolean", "description": "Extract buyer questions and answers from product detail pages.", "default": false }, "maxQuestions": { "title": "Max Questions per Product", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum Q&A pairs to extract per product when includeQuestions is true.", "default": 10 }, "deduplicateProducts": { "title": "Deduplicate Products", "type": "boolean", "description": "Remove duplicate products that appear across multiple search queries. Recommended when using multiple queries.", "default": true }, "maxConcurrency": { "title": "Max Concurrent Requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel browser pages. Higher values are faster but use more memory and may trigger more CAPTCHAs. Recommended: 3-5.", "default": 5 }, "maxRequestRetries": { "title": "Max Retries per Request", "minimum": 1, "maximum": 10, "type": "integer", "description": "Retry attempts for failed requests. AliExpress occasionally blocks requests, so retries improve success rate.", "default": 5 }, "proxyCountry": { "title": "Proxy Country", "type": "string", "description": "Country code for residential proxy exit nodes. Should match shipTo for consistent pricing.", "default": "US" }, "captchaApiKey": { "title": "2Captcha API Key", "type": "string", "description": "Optional API key for 2Captcha service for improved CAPTCHA solving reliability." } } }, "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 } } } } } } } } } }