{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper: Product Search, Prices, Orders & Ratings", "description": "Search AliExpress and export products with sale price, discount, rating, orders sold and store. Filter by price, rating and minimum orders.", "version": "0.1", "x-build-id": "0BY10UOjPfYe1txOc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tindacloud~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tindacloud-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/tindacloud~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-tindacloud-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/tindacloud~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-tindacloud-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "What to search for on AliExpress, e.g. “wireless earbuds”. Several keywords at once is fine.", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress search URLs (optional)", "type": "array", "description": "Paste AliExpress search or category URLs to use your own filters instead of the fields below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "ordersDesc", "priceAsc", "priceDesc", "newest" ], "type": "string", "description": "Result order.", "default": "relevance" }, "maxProductsPerQuery": { "title": "Max products per keyword", "minimum": 1, "type": "integer", "description": "Stop after this many products for each keyword.", "default": 100 }, "minPrice": { "title": "Min price", "type": "integer", "description": "Lowest price to include, in the currency below." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Highest price to include, in the currency below." }, "minRating": { "title": "Min rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only products rated at least this (1-5). Products with no rating are skipped." }, "minOrders": { "title": "Min orders sold", "type": "integer", "description": "Only products with at least this many orders — a quick way to filter out untested listings." }, "freeShippingOnly": { "title": "Ships from China only", "type": "boolean", "description": "Restrict to items shipped from China (usually the cheapest).", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "Currency for prices, e.g. USD, EUR, GBP.", "default": "USD" }, "shipTo": { "title": "Ship to country", "type": "string", "description": "Two-letter country code used for prices and shipping, e.g. US, DE, KR.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Site language, e.g. en, de, es.", "default": "en" }, "onlyChangedProducts": { "title": "Only products that changed", "type": "boolean", "description": "Monitoring mode. Remembers each product's price and returns only products whose price actually moved, with the old price attached. AliExpress shuffles its search results, so products you have not seen before are skipped by default — turn on the option below to include them.", "default": false }, "includeNewProductsWhenMonitoring": { "title": "Also include products you have not seen", "type": "boolean", "description": "Only used with monitoring mode. AliExpress rotates search results, so this adds a lot of rows that are not real changes.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Total limit across all keywords.", "default": 1000 }, "proxy": { "title": "Proxy", "type": "object", "description": "Apify Proxy is used as a fallback when a direct request is blocked.", "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 } } } } } } } } } }