{ "openapi": "3.0.1", "info": { "title": "Aliexpress Scraper | Enterprise Grade", "description": "Extract structured AliExpress product and review data including prices, discounts, ratings, images, and merchandising signals. Built for enterprise-grade ecommerce intelligence, sourcing analysis, pricing research, and automated catalog or analytics pipelines.", "version": "1.0", "x-build-id": "pb5SDuPUpZ9iWnNje" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": { "startUrls": { "title": "Start URLs (Search results, category pages, store catalog pages, and product pages)", "type": "array", "description": "Paste one or more AliExpress URLs to scrape directly. Supported page types include search result pages, category pages, store catalog pages, and individual product pages. You can mix these page types in the same run when you want precise control over what gets collected.", "items": { "type": "string" } }, "queries": { "title": "🔎 Search query keywords", "type": "array", "description": "Enter one or more keywords to search on AliExpress, such as product names, brands, model numbers, or product categories. Use this when you do not have URLs yet and want the actor to discover relevant listings through AliExpress search and save them to your dataset.", "items": { "type": "string" } }, "min_price": { "title": "💵 Minimum price", "minimum": 0, "type": "integer", "description": "Optional lower price bound for query-based searches. Use it to exclude very low-priced items." }, "max_price": { "title": "💵 Maximum price", "minimum": 0, "type": "integer", "description": "Optional upper price bound for query-based searches. Use it to exclude products above your target range." }, "sort": { "title": "↔️ Sort results by", "enum": [ "best_match", "most_ordered", "lowest_price", "highest_price" ], "type": "string", "description": "Choose how AliExpress should order search results generated from your queries. Leave the default setting when you want the marketplace's standard ranking.", "default": "best_match" }, "free_shipping": { "title": "🚚 Only show items with free shipping", "type": "boolean", "description": "When enabled, query-based searches keep only products marked with free shipping.", "default": false }, "on_sale": { "title": "🏷️ Only show items on sale", "type": "boolean", "description": "When enabled, query-based searches keep only products with AliExpress sale promotions.", "default": false }, "delivery_choice": { "title": "👨‍🔧 Only show items that have Delivery & service choice", "type": "boolean", "description": "When enabled, query-based searches keep only items marked with Delivery & service choice.", "default": false }, "high_rated": { "title": "⭐️ Only show products with 4 and above star ratings", "type": "boolean", "description": "When enabled, query-based searches keep only products rated 4 stars or higher.", "default": false }, "premium_quality": { "title": "🔖 Only show items with premium quality tags", "type": "boolean", "description": "When enabled, query-based searches keep only products labeled with premium quality tags.", "default": false }, "shipping_to": { "title": "Choose the country the items are shipping to", "enum": [ "AD", "AE", "AF", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FR", "GA", "GB", "GD", "GE", "GH", "GM", "GN", "GQ", "GR", "GT", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KM", "KN", "KR", "KW", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MK", "ML", "MM", "MN", "MO", "MR", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NE", "NG", "NI", "NL", "NO", "NP", "NZ", "OM", "PA", "PE", "PG", "PH", "PK", "PL", "PR", "PS", "PT", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SY", "SZ", "TD", "TG", "TH", "TJ", "TL", "TM", "TN", "TO", "TR", "TT", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VN", "VU", "WS", "XK", "YE", "ZA", "ZM", "ZW" ], "type": "string", "description": "Select the destination country for the items. AliExpress requires a shipping country, and this selection also determines the local market pricing and currency shown in results. For example, choosing France targets items shippable to France and shows prices in euro.", "default": "US" }, "enrich_data": { "title": "Product enrichment (temporarily under maintenance)", "type": "boolean", "description": "Product enrichment is temporarily under maintenance. Even if this option is enabled, the actor will use the regular listing flow and saved product records will not include the enrichment block until this feature is restored.", "default": false }, "getReviews": { "title": "Get reviews for each saved product (saved seperately)", "type": "boolean", "description": "When enabled, the actor also collects every review for each discovered product and saves each review as a separate dataset record with type `review`. Review records include parent product fields such as product ID, title, and product URL, and split review data into top-level `review_metadata`, `reviewer`, and `review_content` blocks for easier downstream use.", "default": false }, "max_reviews": { "title": "Maximum reviews to gather per product", "minimum": 1, "type": "integer", "description": "Optional. Only applies when review collection is enabled. Limits how many review records are saved for each product individually, rather than applying one shared cap across the whole run. Leave empty to fetch all available reviews for each product." }, "limit": { "title": "Maximum product listings to save (per seed)", "minimum": 1, "type": "integer", "description": "Stop the run after this many product listings have been saved for each seed. This cap applies to discovered product listing records only, not to review records or other derived outputs. Choose a smaller number for quick sampling or validation, and increase it when you need broader coverage for research, monitoring, or larger datasets.", "default": 50000 } } }, "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 } } } } } } } } } }