{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper - Products, Prices, SKUs & Reviews", "description": "Scrape AliExpress products by keyword, category or product URL. Get price, discount, rating, orders sold and images, plus optional details: every SKU variant with price and stock, shipping options, specs and store info. Optional reviews. Any country, currency and language.", "version": "1.0", "x-build-id": "RgQdVP9MqJdLEHfGk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/randy-tools~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-randy-tools-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/randy-tools~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-randy-tools-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/randy-tools~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-randy-tools-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search, e.g. \"phone case\", \"yoga mat\". Each term is scraped up to 'Max products per search or URL'.", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress URLs", "type": "array", "description": "Product URLs (aliexpress.com/item/...), search result URLs (/w/wholesale-...) or category URLs (/category/...). Product URLs always include full details.", "items": { "type": "string" } }, "maxItems": { "title": "Max products per search or URL", "minimum": 1, "maximum": 3600, "type": "integer", "description": "AliExpress shows 60 products per page, up to 60 pages.", "default": 60 }, "sortBy": { "title": "Sort by", "enum": [ "default", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of search and category results.", "default": "default" }, "minPrice": { "title": "Min price", "type": "integer", "description": "Only products at or above this price, in the selected currency." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Only products at or below this price, in the selected currency." }, "includeDetails": { "title": "Include full product details", "type": "boolean", "description": "Adds every SKU variant (attributes, price, stock, image), shipping options with fees and delivery times, specifications, full image gallery, review count, wishlist count and store info. Charged as an extra event per product.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "0 = no reviews. Reviews include rating, text, English translation, date, variant bought, buyer country and photos.", "default": 0 }, "country": { "title": "Ship-to country", "type": "string", "description": "Two-letter country code, e.g. US, GB, DE, FR, ES, AU, CA. Sets availability, prices and shipping options.", "default": "US" }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency code, e.g. USD, EUR, GBP, AUD, CAD.", "default": "USD" }, "language": { "title": "Language", "enum": [ "en_US", "de_DE", "fr_FR", "es_ES", "it_IT", "pt_PT", "nl_NL", "pl_PL", "tr_TR", "ko_KR", "ja_JP", "ar_MA", "he_IL", "th_TH", "vi_VN", "in_ID" ], "type": "string", "description": "Language of titles and review translations.", "default": "en_US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (the default) works best: AliExpress challenges residential IPs more often. Proxy costs are included in the price.", "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 } } } } } } } } } }