{
"openapi": "3.0.1",
"info": {
"title": "AliExpress Product Scraper: Exact Sales & Prices",
"description": "Find best-selling AliExpress products: exact sold count instead of \"10,000+ sold\", price and regular price, discount, rating, delivery days, Choice and ad labels, store and search position. Keywords or category links, any ship-to country.",
"version": "0.1",
"x-build-id": "vRGFc4Gac0kDgumgt"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/robertosan16~aliexpress-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-robertosan16-aliexpress-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/robertosan16~aliexpress-search-scraper/runs": {
"post": {
"operationId": "runs-sync-robertosan16-aliexpress-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/robertosan16~aliexpress-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-robertosan16-aliexpress-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": {
"searchQueries": {
"title": "Search keywords",
"type": "array",
"description": "Words to search on AliExpress, one search per line, as in the search box.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Search or category links",
"type": "array",
"description": "Links copied from AliExpress: a search such as https://www.aliexpress.com/w/wholesale-yoga-mat.html or a category such as https://www.aliexpress.com/category/100003109/women-clothing.html. Filters in the link (category, price, ship-from, free shipping) are kept.",
"items": {
"type": "string"
}
},
"sort": {
"title": "Sort by",
"enum": [
"relevance",
"orders",
"price_asc",
"price_desc"
],
"type": "string",
"description": "The order of the results, as on AliExpress. \"Orders\" puts the best sellers first.",
"default": "relevance"
},
"maxItemsPerSearch": {
"title": "Products per search",
"minimum": 1,
"maximum": 3600,
"type": "integer",
"description": "How many products to save for each keyword or link. AliExpress shows 60 products per page and at most 60 pages (3,600 products).",
"default": 100
},
"shipTo": {
"title": "Ship to",
"enum": [
"AU",
"AT",
"BE",
"BR",
"BG",
"CA",
"CL",
"CO",
"HR",
"CZ",
"DK",
"EG",
"FI",
"FR",
"DE",
"GR",
"HU",
"IN",
"ID",
"IE",
"IL",
"IT",
"JP",
"KZ",
"MY",
"MX",
"MA",
"NL",
"NZ",
"NG",
"NO",
"PE",
"PH",
"PL",
"PT",
"RO",
"SA",
"SG",
"SK",
"ZA",
"KR",
"ES",
"SE",
"CH",
"TH",
"TR",
"UA",
"AE",
"GB",
"US",
"VN"
],
"type": "string",
"description": "The delivery country. AliExpress shows prices, delivery times and some products for this country. Keyword searches work for every country; category pages are empty when shipping to France or Spain.",
"default": "US"
},
"currency": {
"title": "Currency",
"enum": [
"AED",
"AUD",
"BRL",
"CAD",
"CHF",
"CLP",
"COP",
"CZK",
"DKK",
"EGP",
"EUR",
"GBP",
"HUF",
"IDR",
"ILS",
"INR",
"JPY",
"KRW",
"KZT",
"MAD",
"MXN",
"MYR",
"NGN",
"NOK",
"NZD",
"PEN",
"PHP",
"PLN",
"RON",
"SAR",
"SEK",
"SGD",
"THB",
"TRY",
"UAH",
"USD",
"VND",
"ZAR"
],
"type": "string",
"description": "The currency of the prices. Leave empty for the currency of the ship-to country."
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "number",
"description": "Only products from this price, in the currency above."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "number",
"description": "Only products up to this price, in the currency above."
},
"shipFrom": {
"title": "Ships from",
"enum": [
"CN",
"US",
"GB",
"DE",
"FR",
"ES",
"IT",
"PL",
"CZ",
"BE",
"NL",
"KR",
"TR",
"BR",
"MX",
"CL",
"AU",
"SA",
"AE",
"IL",
"UA"
],
"type": "string",
"description": "Only products shipped from this country, such as the local warehouses in the United States or Spain."
},
"minRating": {
"title": "Minimum rating",
"minimum": 0,
"maximum": 5,
"type": "number",
"description": "Only products rated this or higher, from 0 to 5. Products without a rating yet are skipped when this is set."
},
"minSold": {
"title": "Minimum sold",
"minimum": 0,
"type": "integer",
"description": "Only products sold at least this many times. Products without sales are skipped when this is set. With \"Orders\" sorting, a search stops at the first page where every product is below this number."
},
"skipSponsored": {
"title": "Skip ads",
"type": "boolean",
"description": "Leave out sponsored products (marked \"Ad\" on AliExpress). They are kept by default and marked in the isSponsored field.",
"default": false
},
"maxItems": {
"title": "Maximum results",
"minimum": 0,
"type": "integer",
"description": "Stop after this many products in total. Leave empty or 0 for no limit."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "AliExpress shows a check page after a few pages from one address; the Actor then continues from a new address. Residential addresses in the United Kingdom work best (addresses in the United States are sent to aliexpress.us).",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "GB"
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}