{
"openapi": "3.0.1",
"info": {
"title": "AliExpress Product Scraper - Prices, Variants & Reviews",
"description": "Extract AliExpress products with exact sales counts, prices, every variant with its own stock, seller stats, and buyer reviews with photos. Pick your delivery country, currency and language: catalog, prices, VAT and delivery times all follow. 65 fields per product. Export to JSON, CSV, Excel.",
"version": "0.0",
"x-build-id": "Zq3QILRaFMhaKaNVO"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zen-studio~aliexpress-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zen-studio-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/zen-studio~aliexpress-scraper/runs": {
"post": {
"operationId": "runs-sync-zen-studio-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/zen-studio~aliexpress-scraper/run-sync": {
"post": {
"operationId": "run-sync-zen-studio-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": {
"keywords": {
"title": "Search terms",
"type": "array",
"description": "What to search for on AliExpress. Add one or more terms, for example led strip light. Leave empty if you are scraping specific product URLs instead.",
"items": {
"type": "string"
}
},
"productUrls": {
"title": "Product URLs",
"type": "array",
"description": "Scrape specific products instead of searching. Paste AliExpress product links (or product IDs), one per line. Use this to track prices and stock for products you already know. Products added here always come back with full details, and are billed accordingly. Either search terms or product URLs are required.",
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Number of products",
"minimum": 0,
"type": "integer",
"description": "How many products to return in total, shared across your search terms. Set 0 for no limit, which collects everything AliExpress will show for each term (about 3,590 products each). With full product details on, no limit can run to roughly $23 per search term, so set a spending limit on the run if you use it. On the Apify free plan every run returns up to 62 products.",
"default": 50
},
"country": {
"title": "Deliver to",
"enum": [
"US",
"GB",
"DE",
"FR",
"ES",
"IT",
"NL",
"PL",
"BR",
"CA",
"AU",
"MX",
"JP",
"KR",
"IN",
"SA",
"AE",
"TR"
],
"type": "string",
"description": "The market to shop from. This changes which products are shown, their prices, taxes and delivery times.",
"default": "US"
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"BRL",
"CAD",
"AUD",
"JPY",
"KRW",
"INR",
"MXN",
"PLN",
"TRY"
],
"type": "string",
"description": "Currency for all prices.",
"default": "USD"
},
"language": {
"title": "Language",
"enum": [
"en_US",
"de_DE",
"fr_FR",
"es_ES",
"it_IT",
"nl_NL",
"pl_PL",
"pt_BR",
"ja_JP",
"ko_KR",
"tr_TR"
],
"type": "string",
"description": "Language for titles and descriptions.",
"default": "en_US"
},
"sort": {
"title": "Sort by",
"enum": [
"relevance",
"orders",
"price_asc",
"price_desc"
],
"type": "string",
"description": "How to order the results.",
"default": "relevance"
},
"filters": {
"title": "Filters",
"type": "array",
"description": "Narrow the results down.",
"items": {
"type": "string",
"enum": [
"big_sale",
"free_shipping",
"ships_from_local",
"choice",
"four_star_plus"
],
"enumTitles": [
"On sale",
"Free shipping",
"Ships from my country",
"AliExpress Choice",
"4 stars and up"
]
},
"default": []
},
"priceMin": {
"title": "Minimum price",
"type": "integer",
"description": "Lowest price to include, in the selected currency."
},
"priceMax": {
"title": "Maximum price",
"type": "integer",
"description": "Highest price to include, in the selected currency."
},
"shipFrom": {
"title": "Ships from",
"enum": [
"",
"CN",
"US",
"ES",
"FR",
"DE",
"PL",
"IT",
"NL",
"BE",
"CZ",
"GB",
"TR",
"RU",
"KR",
"JP",
"AU",
"BR",
"CA",
"MX"
],
"type": "string",
"description": "Only products dispatched from this country. Use it to find stock that is already near your buyers instead of shipping from China.",
"default": ""
},
"categoryId": {
"title": "Category ID",
"type": "string",
"description": "Restrict the search to one AliExpress category. Run a search first, then copy a postCategoryId from the results to narrow the next run to that category."
},
"includeProductDetails": {
"title": "Include full product details",
"type": "boolean",
"description": "Adds the variant list with per-option stock and price, specifications, seller details and delivery estimates to every product.",
"default": true
},
"includeDescription": {
"title": "Include product description",
"type": "boolean",
"description": "Adds the seller's full description text and images. Makes runs slower.",
"default": false
},
"includeReviews": {
"title": "Include buyer reviews",
"type": "boolean",
"description": "Adds buyer reviews to every product: rating, review text and its translation, buyer country, the exact variant purchased, and photos. Billed per review, and a product can have thousands.",
"default": false
},
"maxReviewsPerProduct": {
"title": "Reviews per product",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "How many reviews to collect for each product. Set 0 for every review, up to the 5,000 AliExpress will show per product. Only used when Include buyer reviews is on.",
"default": 100
},
"reviewFilter": {
"title": "Only these reviews",
"enum": [
"all",
"image",
"additional",
"local"
],
"type": "string",
"description": "Limit which reviews are collected.",
"default": "all"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}