{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper - Products, Prices, Variants & Reviews", "description": "Scrape AliExpress products from keyword searches, categories, stores and product links: price, discount, sold count, rating, store, variants with stock, specifications, shipping cost and delivery dates to your country, plus product reviews.", "version": "0.1", "x-build-id": "iLIBP4Fu1nGZK8sgs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": "Enter words to search AliExpress for, one per line, like phone case or yoga mat.", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress links", "type": "array", "description": "Paste product links (aliexpress.com/item/..., aliexpress.us, de.aliexpress.com, m.aliexpress.com and other country sites), search and category links, store links (aliexpress.com/store/...) or s.click.aliexpress.com / a.aliexpress.com short links, one per line. Product IDs work too.", "items": { "type": "string" } }, "scrapeType": { "title": "What to scrape", "enum": [ "products", "reviews" ], "type": "string", "description": "Products: one row per product. Reviews: the reviews of the products your keywords and links lead to, one row per review.", "default": "products" }, "maxProducts": { "title": "Max products per keyword or link", "minimum": 0, "type": "integer", "description": "Set how many products to take from each keyword, category or store. 0 takes all of them (a search shows at most 3,600). In reviews mode, how many products to read reviews for.", "default": 100 }, "includeDetails": { "title": "Include full product details", "type": "boolean", "description": "Open every product from a search or store for its variants with prices and stock, specifications, shipping cost and delivery dates to your country, store rating and followers, and review count. Slower and priced per detailed product. Product links always come with full details.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Reviews mode: how many reviews to save for each product. 0 saves all of them.", "default": 20 }, "reviewsWithImagesOnly": { "title": "Only reviews with photos", "type": "boolean", "description": "Reviews mode: save only reviews that include photos.", "default": false }, "shipTo": { "title": "Ship to", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BE", "PL", "PT", "SE", "NO", "DK", "FI", "IE", "AT", "CH", "CZ", "HU", "RO", "GR", "UA", "TR", "IL", "SA", "AE", "CA", "MX", "BR", "CL", "CO", "PE", "AR", "AU", "NZ", "JP", "KR", "SG", "MY", "TH", "VN", "PH", "ID", "IN", "PK", "ZA", "NG", "EG", "MA", "KZ" ], "type": "string", "description": "Choose the country you ship to: prices, shipping costs, delivery dates and what is available follow it.", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "JPY", "KRW", "BRL", "MXN", "CLP", "COP", "PEN", "PLN", "CZK", "HUF", "SEK", "NOK", "DKK", "CHF", "TRY", "UAH", "ILS", "SAR", "AED", "INR", "IDR", "THB", "VND", "PHP", "MYR", "SGD", "ZAR", "NGN", "KZT", "MAD", "EGP" ], "type": "string", "description": "Choose the currency prices and shipping costs are shown in.", "default": "USD" }, "language": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "pt", "nl", "pl", "tr", "ru", "ja", "ko", "ar", "he", "th", "vi", "id" ], "type": "string", "description": "Choose the language of titles, specifications and shipping texts.", "default": "en" }, "sortBy": { "title": "Sort search results by", "enum": [ "relevance", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of products for search keywords and links.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Search: only products from this price, in whole units of the chosen currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Search: only products up to this price, in whole units of the chosen currency." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Keep the default for the best results.", "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 } } } } } } } } } }