{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper", "description": "Scrape AliExpress search results, product details, store profiles, and customer reviews. Multi-region (com / us / ru / es / fr / de / it / nl / pt / pl / ar / tr / ko / ja / vi / th / id / he), multi-currency, with sort, price, rating, and ship-from/ship-to filters.", "version": "1.0", "x-build-id": "bWZDPg9Oyda4cUXCM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "mode": { "title": "Mode", "enum": [ "search", "byProduct", "byStore", "byReviews", "byUrl" ], "type": "string", "description": "What to scrape. search: text-query results. byProduct: product detail by ID. byStore: store profile by ID. byReviews: customer reviews for product IDs. byUrl: parse any AliExpress URL (search, item, store, or feedback).", "default": "search" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text search query, e.g. \"phone case\", \"led strip\", \"running shoes\". Required when mode=search.", "default": "phone case" }, "productIds": { "title": "Product IDs (mode=byProduct or byReviews)", "type": "array", "description": "AliExpress numeric product IDs (e.g. 1005010155028387). Each ID becomes one fetch in byProduct, or one batch of reviews in byReviews.", "default": [], "items": { "type": "string" } }, "storeIds": { "title": "Store IDs (mode=byStore)", "type": "array", "description": "AliExpress numeric store IDs from /store/{id} URLs.", "default": [], "items": { "type": "string" } }, "urls": { "title": "URLs (mode=byUrl)", "type": "array", "description": "Any mix of AliExpress URLs: search (/wholesale or /w/...), product (/item/{id}.html), store (/store/{id}), or feedback (/pc/searchEvaluation.do?productId={id}). Region is auto-detected from the host.", "default": [], "items": { "type": "string" } }, "region": { "title": "Regional storefront", "enum": [ "com", "us", "ru", "es", "fr", "de", "it", "nl", "pt", "pl", "ar", "tr", "ko", "ja", "vi", "th", "id", "he" ], "type": "string", "description": "AliExpress regional sub-domain to query. com is the global English storefront; us is the United States storefront; the rest are language-localized variants.", "default": "com" }, "currency": { "title": "Currency", "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": "ISO-4217 currency code; controls the prices AliExpress renders in the response (via the aep_usuc_f cookie).", "default": "USD" }, "language": { "title": "UI 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": "Locale that AliExpress should render text in (b_locale cookie).", "default": "en_US" }, "sortBy": { "title": "Sort order (mode=search)", "enum": [ "default", "orders_desc", "newest", "price_asc", "price_desc" ], "type": "string", "description": "How AliExpress should sort the search results.", "default": "default" }, "priceMin": { "title": "Minimum price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum price (in the selected currency). Records below this are excluded.", "default": 0 }, "priceMax": { "title": "Maximum price", "minimum": 0, "maximum": 1000000, "type": "integer", "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 (0–5, accepts decimals like 4.5). Records below are excluded; products with no rating are kept (the user opted into a filter, not into requiring the field).", "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": "ISO 3166-1 alpha-2 country code of the warehouse the item ships from (CN by default).", "default": "" }, "shipTo": { "title": "Ship to country", "enum": [ "", "US", "CN", "RU", "ES", "FR", "DE", "IT", "GB", "PL", "TR", "BR", "JP", "KR", "AU", "CA", "MX", "AE", "SA", "IL", "TH", "VN", "ID", "MY", "NL", "BE", "PT", "IN", "PK", "EG", "ZA", "NG" ], "type": "string", "description": "ISO 3166-1 alpha-2 country to ship to (also drives currency / locale defaults).", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 25 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 60, "type": "integer", "description": "Maximum pagination pages per search query (60 items per page).", "default": 3 }, "enrichReviews": { "title": "Enrich with reviews", "type": "boolean", "description": "If true, fetch up to maxReviewsPerProduct customer reviews for every product record.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "maximum": 200, "type": "integer", "description": "Cap on how many reviews to keep per product (when enrichReviews=true, or in mode=byReviews). 0 disables.", "default": 0 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route requests through Apify proxy. AliExpress is generally accessible without a proxy from datacenter IPs; enable only if you see frequent rate limits.", "default": false }, "autoEscalateOnBlock": { "title": "Auto-escalate on block", "type": "boolean", "description": "If a request is blocked or rate-limited, transparently switch to Apify residential proxy for retries.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Used only when useProxy is enabled.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }