{ "openapi": "3.0.1", "info": { "title": "AliExpress Product Scraper - Prices, Sales & Ratings", "description": "Scrape AliExpress search results by keyword: price, original price, discount percent, exact units sold, star rating, warehouse country, launch date and a sponsored-listing flag. Sort by price or orders, filter by price range. No login needed.", "version": "0.1", "x-build-id": "kde3IbSd3FTBjihXu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~aliexpress-product-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-aliexpress-product-search-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/cirkit~aliexpress-product-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-aliexpress-product-search-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/cirkit~aliexpress-product-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-aliexpress-product-search-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": { "searchTerms": { "title": "Search terms", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Keywords to search on AliExpress, one per line. Each term is walked page by page (60 products per page). Works with any language, including Chinese.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many products in total, across all search terms. Set to 0 for no limit. This is what you are billed on, so it is the safest way to cap spend.", "default": 200 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "ordersDesc", "priceAsc", "priceDesc" ], "type": "string", "description": "How AliExpress should order the results. 'Most orders' surfaces proven sellers, which is usually what you want for product research. There is no 'newest' option because AliExpress does not honour one; use the launchedAt field in the output to find new listings instead.", "default": "relevance" }, "minPrice": { "title": "Minimum price (USD)", "minimum": 0, "type": "integer", "description": "Only return products at or above this price. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price (USD)", "minimum": 0, "type": "integer", "description": "Only return products at or below this price. Leave empty for no maximum." }, "excludeSponsored": { "title": "Exclude sponsored listings", "type": "boolean", "description": "AliExpress mixes paid placements into organic search results. Turn this on to drop them and keep only organic listings. Every row carries an isSponsored flag either way.", "default": false }, "maxPagesPerQuery": { "title": "Max pages per search term", "minimum": 1, "maximum": 60, "type": "integer", "description": "Hard cap on how deep to page into one search term. 60 products per page, and AliExpress serves at most 60 pages per query (about 3,600 products). Leave empty to page until the results run out." }, "startUrls": { "title": "Start URLs (optional)", "uniqueItems": true, "type": "array", "description": "AliExpress search URLs to scrape directly, if you would rather build the search on the site and paste the link. Supports /w/wholesale-*.html search pages and /category/ browse pages. Filters already in your URL are kept as-is. Single /item/ product pages are not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The default Apify datacenter proxy is enough for AliExpress and is the cheapest option; there is no need to pay for residential here.", "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 } } } } } } } } } }