{
"openapi": "3.0.1",
"info": {
"title": "AliExpress Scraper – Search, Prices & Sales",
"description": "Scrape AliExpress search and category results for any of 55 delivery countries: price, original price, discount, currency, sold count, rating, free shipping, delivery dates, Choice, ads, new-shopper deals, store and images. Up to 3,600 products per search. Pay only per product.",
"version": "1.0",
"x-build-id": "o3MrafqscwZBUOObX"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/brii3343~aliexpress-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-brii3343-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/brii3343~aliexpress-scraper/runs": {
"post": {
"operationId": "runs-sync-brii3343-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/brii3343~aliexpress-scraper/run-sync": {
"post": {
"operationId": "run-sync-brii3343-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": {
"searches": {
"title": "Search keywords",
"type": "array",
"description": "Products to search for, one per line, for example phone case, wireless earbuds, led strip lights. Each keyword is one search, read page by page (60 products per page).",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "AliExpress URLs",
"type": "array",
"description": "AliExpress search or category pages, with any filters you set on the site, for example https://www.aliexpress.com/w/wholesale-phone-case.html?SortType=total_tranpro_desc or https://www.aliexpress.com/category/100003109/women-clothing.html. Product pages are not supported yet.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"shipTo": {
"title": "Ship to",
"enum": [
"US",
"GB",
"CA",
"AU",
"NZ",
"IE",
"DE",
"FR",
"IT",
"ES",
"NL",
"BE",
"AT",
"PT",
"FI",
"GR",
"SK",
"SI",
"LT",
"LV",
"EE",
"LU",
"PL",
"CZ",
"HU",
"RO",
"BG",
"SE",
"DK",
"NO",
"CH",
"UA",
"TR",
"IL",
"SA",
"AE",
"KR",
"JP",
"SG",
"MY",
"TH",
"PH",
"ID",
"VN",
"IN",
"KZ",
"BR",
"MX",
"CL",
"CO",
"PE",
"ZA",
"MA",
"EG",
"NG"
],
"type": "string",
"description": "Delivery country. AliExpress shows different prices, shipping, delivery dates and products for each country.",
"default": "US"
},
"currency": {
"title": "Currency",
"enum": [
"auto",
"USD",
"EUR",
"GBP",
"CAD",
"AUD",
"NZD",
"PLN",
"CZK",
"HUF",
"RON",
"BGN",
"SEK",
"DKK",
"NOK",
"CHF",
"UAH",
"TRY",
"ILS",
"SAR",
"AED",
"KRW",
"JPY",
"SGD",
"MYR",
"THB",
"PHP",
"IDR",
"VND",
"INR",
"KZT",
"BRL",
"MXN",
"CLP",
"COP",
"PEN",
"ZAR",
"MAD",
"EGP",
"NGN"
],
"type": "string",
"description": "Currency of the prices. Country's currency uses the one AliExpress shows to shoppers in the delivery country.",
"default": "auto"
},
"maxItemsPerSource": {
"title": "Max products per search or URL",
"minimum": 0,
"type": "integer",
"description": "Products to save for each keyword and each URL. AliExpress shows 60 products per page and up to 60 pages (3,600 products). 0 = all pages.",
"default": 60
},
"sort": {
"title": "Sort by",
"enum": [
"default",
"orders",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Order of the results, as on the site. Applies to keywords and to URLs that do not set their own order.",
"default": "default"
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "Only products from this price, in the selected currency. 0 = no minimum.",
"default": 0
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "Only products up to this price, in the selected currency. 0 = no maximum.",
"default": 0
},
"freeShipping": {
"title": "Free shipping only",
"type": "boolean",
"description": "AliExpress filter \"Free shipping\".",
"default": false
},
"fourStarsAndUp": {
"title": "4 stars & up only",
"type": "boolean",
"description": "Keep only products rated 4.0 or more (products without a rating are skipped). Checked on each product, because the site's own 4-star filter stops at 60 products and returns nothing when combined with other filters.",
"default": false
},
"choiceOnly": {
"title": "Choice products only",
"type": "boolean",
"description": "AliExpress Choice: products with faster delivery and free returns in many countries.",
"default": false
},
"maxItems": {
"title": "Max products in total",
"minimum": 0,
"type": "integer",
"description": "Stop after this many products in the whole run. 0 = no limit.",
"default": 0
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed: the scraper connects directly and switches to Apify Proxy residential in the delivery country only when AliExpress blocks it or shows reduced results. Set a proxy here only to force one.",
"default": {
"useApifyProxy": false
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}