{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper — Prices, Orders Sold & Ratings", "description": "Scrape AliExpress search results for any keyword: product ID, title, sale and original price, discount, orders sold, star rating, store, Choice and sponsored flags, delivery estimate, images and URL. Any ship-to country and currency, sort and price filters. No login, no browser.", "version": "0.1", "x-build-id": "6Y3TXMTNZNYLOzGC7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-aliexpress-search-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/yugenox~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-aliexpress-search-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/yugenox~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-aliexpress-search-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": { "keywords": { "title": "🔎 Keywords", "type": "array", "description": "What to search on AliExpress, e.g. \"phone case\", \"yoga mat\", \"led strip lights\". Each keyword is a separate search, exactly like typing it into AliExpress's search box. You can also paste AliExpress search URLs here.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 AliExpress search URLs", "type": "array", "description": "Optional: AliExpress search result URLs (aliexpress.com/w/wholesale-.html?…). The filters and sort in the URL are kept; the scraper pages through the results. Product and store pages are not supported.", "items": { "type": "string" } }, "maxItemsPerKeyword": { "title": "Max products per keyword", "minimum": 0, "maximum": 3600, "type": "integer", "description": "How many products to save for each keyword (AliExpress shows 60 per page and up to 60 pages, so at most 3,600). 0 = as many as AliExpress shows.", "default": 120 }, "maxItems": { "title": "Max products in total", "minimum": 0, "type": "integer", "description": "Optional cap for the whole run, across all keywords. 0 = no cap (only the per-keyword limit applies).", "default": 0 }, "sort": { "title": "Sort by", "enum": [ "bestMatch", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "AliExpress's own sort order. \"Orders\" puts the best sellers first.", "default": "bestMatch" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Only products priced at least this much, in the currency below. Leave empty for no minimum." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Only products priced at most this much, in the currency below. Leave empty for no maximum." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "AliExpress's \"Free shipping\" filter.", "default": false }, "choiceOnly": { "title": "Choice products only", "type": "boolean", "description": "AliExpress's \"Choice\" filter (products with AliExpress's faster delivery and free returns program).", "default": false }, "fourStarsAndUp": { "title": "4 stars & up only", "type": "boolean", "description": "AliExpress's \"4 stars & up\" rating filter.", "default": false }, "includeSponsored": { "title": "Include sponsored listings", "type": "boolean", "description": "AliExpress mixes paid (sponsored) products into the results. They are kept and marked with isSponsored = true. Turn this off to skip them (skipped products are not charged).", "default": true }, "dedupeAcrossKeywords": { "title": "Save each product only once across keywords", "type": "boolean", "description": "When several keywords find the same product, save it only for the first one. Off = each keyword keeps its full ranking (a product can appear once per keyword).", "default": false }, "shipTo": { "title": "Ship to (country)", "enum": [ "US", "CA", "GB", "AU", "NZ", "IE", "DE", "FR", "ES", "IT", "NL", "BE", "AT", "CH", "PT", "PL", "CZ", "SE", "NO", "DK", "FI", "GR", "HU", "RO", "UA", "TR", "IL", "SA", "AE", "KR", "JP", "SG", "MY", "PH", "TH", "VN", "ID", "IN", "MX", "BR", "CL", "CO", "PE", "AR", "ZA", "NG", "EG", "MA" ], "type": "string", "description": "The delivery country AliExpress prices and filters the results for — the same as the \"Ship to\" picker on the site. Shipping to the United States, AliExpress shows its US store (links go to aliexpress.us).", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "CAD", "GBP", "EUR", "AUD", "NZD", "CHF", "PLN", "CZK", "SEK", "NOK", "DKK", "HUF", "RON", "UAH", "TRY", "ILS", "SAR", "AED", "KRW", "JPY", "SGD", "MYR", "PHP", "THB", "VND", "IDR", "INR", "MXN", "BRL", "CLP", "COP", "PEN", "ZAR" ], "type": "string", "description": "Currency for the prices (AliExpress's own conversion). If AliExpress doesn't offer this currency for the chosen country, it uses its own choice and the status message says so; every row carries its currency.", "default": "USD" }, "shipFrom": { "title": "Ships from", "enum": [ "", "CN", "US", "GB", "DE", "FR", "ES", "IT", "PL", "CZ", "BE", "NL", "KR", "BR", "MX", "AU", "SA", "AE", "TR", "IL", "CL" ], "type": "string", "description": "Optional: only products shipped from this country (AliExpress's \"Ships from\" filter), e.g. a local warehouse for faster delivery. Empty = any.", "default": "" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If AliExpress keeps dropping datacenter connections, the run switches to residential proxies when your account has them. If AliExpress shows a security check, the run stops cleanly instead (no charge for products it could not read).", "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 } } } } } } } } } }