{ "openapi": "3.0.1", "info": { "title": "AliExpress Product Scraper — Search, Prices, Variants & Sellers", "description": "Extract AliExpress products by keyword or URL with live prices, discounts, images, sales signals, shipping labels, seller data, specifications, SKU variants and stock. Built for fast product research, dropshipping, supplier discovery, price monitoring and e-commerce datasets.", "version": "1.0", "x-build-id": "RMHeRLBqcRJ63v7rD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~aliexpress-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-aliexpress-product-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/haketa~aliexpress-product-scraper/runs": { "post": { "operationId": "runs-sync-haketa-aliexpress-product-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/haketa~aliexpress-product-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-aliexpress-product-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", "required": [ "maxResults", "shipToCountry", "currency" ], "properties": { "searchTerms": { "title": "🔎 What products do you want?", "type": "array", "description": "Enter one or more product keywords. Each keyword opens a new AliExpress product feed.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "startUrls": { "title": "🔗 Product URLs (optional)", "type": "array", "description": "Paste AliExpress /item/ product URLs when you already know which products to enrich.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "📦 Maximum products", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Total unique product records to save. The default is tuned for a useful bulk export in under 5 minutes.", "default": 150 }, "shipToCountry": { "title": "🌍 Ship-to country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter destination country code used for regional availability and price context.", "default": "US" }, "currency": { "title": "💵 Currency", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Three-letter currency code for displayed prices, for example USD, EUR, GBP or TRY.", "default": "USD" }, "sort": { "title": "↕️ Sort results", "enum": [ "default", "orders", "newest", "priceAsc", "priceDesc" ], "type": "string", "description": "Choose how AliExpress should order each keyword feed.", "default": "default" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Optional lower price boundary in your chosen currency." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Optional upper price boundary in your chosen currency." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep products at or above this public rating when it is displayed." }, "minOrders": { "title": "Minimum orders sold", "minimum": 0, "type": "integer", "description": "Keep products at or above this public order count when it is displayed." }, "freeShipping": { "title": "🚚 Free shipping only", "type": "boolean", "description": "Keep only products carrying a free-shipping label in the selected market.", "default": false }, "includeDetails": { "title": "✨ Enrich product details", "type": "boolean", "description": "Adds seller profile, SKU variants, stock, specifications and extra images. Slower than search-only mode; ideal for a focused shortlist.", "default": false }, "maxDetails": { "title": "Maximum detail enrichments", "minimum": 1, "maximum": 100, "type": "integer", "description": "Protects runtime and cost when detail enrichment is enabled.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended for reliable regional product feeds.", "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 } } } } } } } } } }