{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper: Products, Prices & Reviews", "description": "Scrape AliExpress search results: price, original price, discount, rating, orders sold, ship-from, Choice, images, badges. Any country and currency, sort and price filters. Plus product reviews with text, translation, stars, buyer country, variant and photos.", "version": "1.0", "x-build-id": "mszqjDdPnPTUazZZG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-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/ksvan~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-ksvan-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/ksvan~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-ksvan-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 keywords", "type": "array", "description": "What you would type in the AliExpress search box, e.g. 'wireless earbuds', 'led strip', 'phone case'.", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress search or product URLs", "type": "array", "description": "Optional. Search pages like https://www.aliexpress.com/w/wholesale-wireless-earbuds.html?minPrice=10&maxPrice=30 (filters in the URL are kept) or product pages like https://www.aliexpress.com/item/1005006123456789.html (their reviews are scraped).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProductsPerSearch": { "title": "Max products per search", "minimum": 1, "maximum": 3600, "type": "integer", "description": "AliExpress shows up to 60 pages of 60 products for one search.", "default": 120 }, "sortBy": { "title": "Sort by", "enum": [ "best-match", "orders", "price-asc", "price-desc", "newest" ], "type": "string", "description": "Order of search results.", "default": "best-match" }, "country": { "title": "Ship to country", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "PL", "CA", "AU", "BR", "MX", "KR", "JP", "SA", "AE", "IL", "CL", "BE", "SE", "CH", "PT", "CZ", "NZ" ], "type": "string", "description": "Prices, shipping and availability as shown to buyers in this country.", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "PLN", "CAD", "AUD", "BRL", "MXN", "KRW", "JPY", "SAR", "AED", "ILS", "CLP", "SEK", "CHF", "CZK", "NZD" ], "type": "string", "description": "Currency of prices.", "default": "USD" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional. In the selected currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional. In the selected currency." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only products with free shipping.", "default": false }, "shipFrom": { "title": "Ships from (country code)", "type": "string", "description": "Optional. Two-letter code of the warehouse country, e.g. 'US', 'DE', 'ES', 'PL', 'CN'." }, "skipAds": { "title": "Skip sponsored products", "type": "boolean", "description": "Leave out promoted (ad) results.", "default": false }, "reviewsPerFoundProduct": { "title": "Reviews per found product", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Also scrape this many reviews for every product found by searches. 0 = no reviews.", "default": 0 }, "reviewProducts": { "title": "Products for reviews", "type": "array", "description": "Optional. Product URLs or IDs whose reviews you want, e.g. 1005006123456789.", "items": { "type": "string" } }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Limit for products listed above and product URLs.", "default": 100 }, "maxItems": { "title": "Max records in total", "minimum": 0, "type": "integer", "description": "Stop after this many products + reviews. 0 = no limit.", "default": 0 }, "maxRetries": { "title": "Max retries per page", "minimum": 1, "maximum": 12, "type": "integer", "description": "Each retry uses a new proxy IP.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) works well.", "default": { "useApifyProxy": 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 } } } } } } } } } }