{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper - Search Products, Prices & Ratings", "description": "Scrape and monitor AliExpress products, prices, discounts, ratings, sales, images, and selling points. Get only new or price-changed listings on scheduled runs.", "version": "1.0", "x-build-id": "vb22CIKjLmEYR3IHT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~aliexpress-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-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/thirdwatch~aliexpress-product-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-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/thirdwatch~aliexpress-product-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-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", "properties": { "queries": { "title": "Search Queries", "type": "array", "description": "List of search terms to scrape from AliExpress (e.g. 'phone case', 'led strip lights', 'bluetooth earbuds'). Optional if you set a Category — leave empty to browse a category instead.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "category": { "title": "Category (optional)", "enum": [ "all", "electronics", "phones-accessories", "computers-office", "consumer-electronics", "jewelry-watches", "home-garden", "furniture", "bags-shoes", "mens-clothing", "womens-clothing", "mother-kids", "sports-outdoors", "automotive", "toys-hobbies", "beauty-health", "tools-hardware", "home-appliances" ], "type": "string", "description": "Top-level AliExpress category to browse or search within. Leave as 'All' to search everything. Combine with Subcategory Slug for deeper paths.", "default": "all" }, "subcategorySlug": { "title": "Subcategory Slug (optional)", "type": "string", "description": "Optional deeper niche to narrow the category (e.g. 'wireless earbuds', 'gaming keyboard'). Appended to the search keywords." }, "trending": { "title": "Trending / Bestsellers", "type": "boolean", "description": "When enabled, sorts results by Best Selling (overrides Sort By) to surface AliExpress trending / bestseller products.", "default": false }, "maxResults": { "title": "Max Results Per Query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of products to scrape per search query. AliExpress returns 60 products per page.", "default": 10 }, "sortBy": { "title": "Sort By", "enum": [ "default", "orders", "price_asc", "price_desc" ], "type": "string", "description": "How to sort search results. 'default' = relevance, 'orders' = best selling, 'price_asc' = cheapest first, 'price_desc' = most expensive first.", "default": "default" }, "minPrice": { "title": "Minimum Price (USD)", "type": "number", "description": "Filter products with price above this value (in USD). Leave empty for no minimum." }, "maxPrice": { "title": "Maximum Price (USD)", "type": "number", "description": "Filter products with price below this value (in USD). Leave empty for no maximum." }, "country": { "title": "Country / Currency", "enum": [ "US", "GB", "AU", "DE", "ES", "FR", "IT", "NL", "BR", "MX" ], "type": "string", "description": "Two-letter country code that determines pricing currency and shipping locale. Overrides the proxy country.", "default": "US" }, "monitorMode": { "title": "Price monitoring", "enum": [ "off", "price-changes" ], "type": "string", "description": "Off returns every product. Price changes stores a baseline and returns only newly seen products or products whose sale price changed. Schedule the same input to build a low-noise price alert.", "default": "off" }, "monitorStoreName": { "title": "Monitoring store name", "type": "string", "description": "Optional stable key-value store name. Reuse the same name for every scheduled run of one product watch." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Leave default for best results. The Country field above takes priority, so prices and currency reflect the country you select rather than wherever the request happens to originate.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "shipFromCountry": { "title": "Ship From Country", "type": "string", "description": "2-letter country code to filter items that ship from that country (e.g. US)." }, "freeShippingOnly": { "title": "Free Shipping Only", "type": "boolean", "description": "Only return items with free shipping.", "default": false }, "choiceOnly": { "title": "Choice Items Only", "type": "boolean", "description": "Only return AliExpress Choice items (faster shipping, vetted sellers).", "default": false }, "language": { "title": "Language", "type": "string", "description": "Result page language code (e.g. en, es, fr). Default: English." } } }, "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 } } } } } } } } } }