{ "openapi": "3.0.1", "info": { "title": "AliExpress Products Scraper", "description": "Product listings from AliExpress search and category pages: title, sale and original price, star rating, orders sold, images and badges. Locale-pinned so language and currency stay fixed, with cross-page de-duplication.", "version": "0.1", "x-build-id": "yM2mg8hfuZZY50kCE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-aliexpress-products-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/scrapyx~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-aliexpress-products-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/scrapyx~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-aliexpress-products-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", "urls" ], "type": "string", "description": "'search' builds listing URLs from your keywords. 'urls' takes AliExpress listing URLs you already have. Product detail pages (/item/…) are not supported and are refused with an explanation — they are WAF-gated and cannot be read over HTTP.", "default": "search" }, "keywords": { "title": "Keywords", "type": "array", "description": "Search terms, one per row. Each becomes a listing URL of the form /w/wholesale-.html and is paged independently.", "default": [ "mechanical keyboard" ], "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "AliExpress LISTING URLs (a /w/wholesale-*.html search page or a category page). Used by the 'urls' mode.", "default": [], "items": { "type": "string" } }, "locale": { "title": "Locale (country / currency / language)", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BR", "RU", "ID" ], "type": "string", "description": "Pins the country, currency and language. This matters more than it looks: with no pin, AliExpress decides from the exit IP, so on a rotating residential proxy one run can mix languages AND currencies. It also changes the RANKING — the same query returned a straw handbag as the top 'laptop' hit on one locale and an actual laptop on another.", "default": "US" }, "sortBy": { "title": "Sort by", "enum": [ "default", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "Result ordering. All four values were verified to genuinely change the results. An unrecognised value is refused here rather than sent, because upstream does NOT reject one — it silently returns default ordering with HTTP 200.", "default": "default" }, "maxPages": { "title": "Max pages per keyword", "minimum": 1, "maximum": 60, "type": "integer", "description": "How many listing pages to fetch per keyword or URL. Each page is 60 products before de-duplication. Paging also stops early on a short page or on a page that introduces no new products.", "default": 3 }, "maxItems": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Optional cap on total product rows across the whole run, shared across every keyword. Counted AFTER de-duplication, so you get the number you asked for." }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many requests may be in flight at once. Kept low by default: this property rate-limits page fetches aggressively, and a challenged request costs more than a slow one.", "default": 2 }, "minRequestInterval": { "title": "Minimum interval between requests (seconds)", "minimum": 0.1, "maximum": 15, "type": "number", "description": "The honest speed control: the shortest gap between two request starts. Deliberately unhurried — the WAF here answers with HTTP 200 and a challenge body, so pushing harder costs pages rather than failing loudly.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy on the shared datacenter pool. This is the default because it is included in your plan at no extra cost and this target works through it. If you start seeing blocks, challenges or empty results, switch the group here to Residential -- it uses real consumer IPs and gets through more, but Apify bills residential traffic per gigabyte, so leave it off unless you need it.", "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 } } }, "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 } } } } } } } } } }