{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper Pro — Prices, Variants & Shipping", "description": "AliExpress search + product pages: variants/SKU, shipping, delivery, seller, specs. All result pages, dedupe and price/orders monitoring. JSON/CSV.", "version": "0.1", "x-build-id": "qegYe9rM47OoBgtLc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datarock~aliexpress-search-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datarock-aliexpress-search-pro", "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/datarock~aliexpress-search-pro/runs": { "post": { "operationId": "runs-sync-datarock-aliexpress-search-pro", "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/datarock~aliexpress-search-pro/run-sync": { "post": { "operationId": "run-sync-datarock-aliexpress-search-pro", "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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords, product URLs or product IDs", "type": "array", "description": "Search phrases, AliExpress product URLs (…/item/1005….html) or product IDs, mixed in one list (auto-detected). No limit.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "default", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "Order of search results.", "default": "default" }, "shipTo": { "title": "Ship-to country", "type": "string", "description": "ISO-2 code (US, GB, DE, FR, BR...). Affects prices, shipping and availability. The connection country follows it unless you set one.", "default": "US" }, "currency": { "title": "Currency", "type": "string", "description": "ISO-4217 code (USD, EUR, GBP...).", "default": "USD" }, "language": { "title": "Language", "type": "string", "description": "en, es, fr, de, pt, it, ru... (titles are returned in this language when AliExpress has a translation).", "default": "en" }, "maxItemsPerKeyword": { "title": "Max products per keyword (0 = all)", "minimum": 0, "type": "integer", "description": "0 = page through to the end of the results (or Max pages per keyword).", "default": 20 }, "maxPagesPerKeyword": { "title": "Max result pages per keyword", "minimum": 1, "maximum": 200, "type": "integer", "description": "60 products per page (about 48 new after duplicates). Default 10 pages; allowed 1-200, tested up to 10 pages.", "default": 1 }, "maxItems": { "title": "Max products per run (0 = no limit)", "minimum": 0, "type": "integer", "description": "Max products for the whole run (0 = no limit).", "default": 0 }, "includeDetails": { "title": "Open product pages for full details", "type": "boolean", "description": "Adds variants/SKUs (price, stock), shipping options, ship-from and delivery estimate, store name/ID/URL/rating, specs, all images, review count. Off = search data only (faster); no product page is opened.", "default": true }, "detailsConcurrency": { "title": "Parallel product pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Higher = faster.", "default": 5 }, "dedupe": { "title": "Remove duplicates across keywords", "type": "boolean", "description": "One row per product; 'matchedKeywords' lists all keywords that returned it.", "default": true }, "onlyNewOrChanged": { "title": "Only new or changed since last run (monitoring)", "type": "boolean", "description": "For schedules: return only products that are new or whose price, original price or sold count changed, with previous values and 'changedFields'. Unchanged products are not re-opened. State kept in your named key-value store 'aliexpress-pro-state'.", "default": false }, "stateKey": { "title": "State key (optional)", "type": "string", "description": "Custom name for the monitoring memory, to share or separate it between schedules. Default: derived from keywords, ship-to, currency, language and sort." }, "keywordTimeoutSecs": { "title": "Time limit per keyword (seconds)", "minimum": 10, "maximum": 86400, "type": "integer", "description": "Search paging for a keyword stops at this limit and keeps the products found so far.", "default": 300 }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 86400, "type": "integer", "description": "The run stops cleanly and saves results when this time is reached; unfinished products get status 'partial'. The run also stops early enough (about 45 s before) to save data and RUN_REPORT before the platform run timeout.", "default": 240 }, "maxCostUsd": { "title": "Max platform cost per run (USD, 0 = off)", "minimum": 0, "type": "number", "description": "Stops the run cleanly when the in-run cost estimate reaches this amount in USD. It is an estimate, not an invoice; unfinished products get status 'partial'. Separate from Apify's own 'max total charge' run option. 0 = no limit.", "default": 0 }, "outputFormat": { "title": "Output format", "enum": [ "nested", "flat" ], "type": "string", "description": "'flat' turns variants, specs, images and shipping options into text columns.", "default": "nested" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Connection settings. The country follows the ship-to country unless you set one.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "saveRawSample": { "title": "Debug: save one raw product response", "type": "boolean", "description": "Saves the first raw product-page response to the key-value store as DETAIL_SAMPLE.", "default": false } } }, "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 } } } } } } } } } }