{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper", "description": "AliExpress product scraper for search, category and product pages: price, discount, rating and sales count, plus variants with per-SKU price and stock, shipping options, store and specifications. Choose the currency and ship-to country.", "version": "1.0", "x-build-id": "WqqPpbt3yZUrupaKK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logical_scrapers~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logical_scrapers-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/logical_scrapers~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-logical_scrapers-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/logical_scrapers~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-logical_scrapers-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", "type": "array", "description": "AliExpress search, category or product URLs. Search URLs (e.g. /w/wholesale-smartphone.html) and category URLs (e.g. /category/100003109/women-clothing.html) return the products listed on them; product URLs (e.g. /item/1005006789883056.html) return that product with its variants, shipping and store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Numeric AliExpress product IDs (e.g. 1005006789883056) to scrape, as an alternative to pasting product URLs. Each returns the full product record.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "type": "integer", "description": "Maximum number of product items to scrape per URL", "default": 10 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Add variants (per-SKU price, stock and image), shipping options, store, review count, image gallery and specifications to every search and category result. Takes one extra request per product, so runs are slower. Product URLs and IDs always include details.", "default": false }, "includeDescription": { "title": "Include description HTML", "type": "boolean", "description": "Also return each product's full HTML description. Applies to products with details (product URLs and IDs, or Include product details). Adds a large field to each item.", "default": false }, "minSold": { "title": "Minimum times sold", "minimum": 0, "type": "integer", "description": "Keep only search and category results sold at least this many times. Leave empty for no limit. Results that show no sales count are left out when this is set." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only search and category results rated at least this many stars (0–5, e.g. 4.5). Leave empty for no limit. Unrated results are left out when this is set." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "PLN", "SEK", "DKK", "NOK", "CHF", "CAD", "AUD", "BRL", "AED", "SAR" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "shipToCountry": { "title": "Ship-to country", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BE", "PL", "SE", "DK", "FI", "NO", "CH", "AT", "IE", "PT", "CZ", "CA", "AU", "BR", "AE", "SA", "IL" ], "type": "string", "description": "Country that shipping options are quoted for. For shipping outside the US, also set the proxy country to this country.", "default": "US" }, "language": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "nl", "pt", "pl", "sv", "ar" ], "type": "string", "description": "Language for product titles and option names. Option values come from the seller and may stay in their original language.", "default": "en" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by the scraper", "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 } } } } } } } } } }