{
"openapi": "3.0.1",
"info": {
"title": "AliExpress Product Details Scraper & Shipping",
"description": "AliExpress product details by URL or ID: every variant (SKU) with its price, stock and purchase limit, new-shopper prices flagged, shipping cost and delivery time to your country, specs, photos, video, rating, units sold and business store. One flat row per product, no personal data.",
"version": "0.1",
"x-build-id": "sIGjH540AiXFffAd6"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/myth84~aliexpress-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-myth84-aliexpress-product-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/myth84~aliexpress-product-scraper/runs": {
"post": {
"operationId": "runs-sync-myth84-aliexpress-product-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/myth84~aliexpress-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-myth84-aliexpress-product-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": {
"productUrls": {
"title": "AliExpress product URLs or ids",
"type": "array",
"description": "One product per line, copied from your browser: https://www.aliexpress.com/item/1005006959700436.html (any language sub-domain such as fr. or de., m.aliexpress.com, /i/ links and query parameters are fine; aliexpress.us links are converted) or just the product id 1005006959700436. 1 to 1,000 products; duplicates are fetched once. aliexpress.ru is a separate platform and is not supported; search pages are not accepted (use the AliExpress search scraper of the studio).",
"items": {
"type": "string",
"pattern": "^(https?://|([a-z]{1,3}\\.)?aliexpress\\.|www\\.aliexpress\\.|\\d)"
}
},
"country": {
"title": "Ship-to (delivery) country",
"pattern": "^[A-Za-z]{2}$",
"type": "string",
"description": "ISO 3166-1 alpha-2 code of the delivery (ship-to) country: US, GB, FR, DE, ES… Prices, stock, shipping options, delivery dates and the warehouse follow it. Pick one from the list or type any code; recorded in viewCountryCode. Default US, matching the default currency USD; use FR or DE with EUR, GB with GBP.",
"default": "US"
},
"currency": {
"title": "Currency",
"pattern": "^[A-Za-z]{3}$",
"type": "string",
"description": "ISO 4217 code of the currency for every price (USD, EUR, GBP…). Pick one from the list or type any code AliExpress supports. Default USD: pair it with the country (EUR for FR or DE, GBP for GB).",
"default": "USD"
},
"language": {
"title": "Language",
"enum": [
"en",
"fr",
"de",
"es",
"it",
"pt",
"nl",
"pl",
"tr",
"ja",
"ko",
"ru",
"uk",
"th",
"vi",
"id",
"ar",
"he"
],
"type": "string",
"description": "Language of the titles, variant names and specifications. Default en: English texts whatever the ship-to country, easiest to compare.",
"default": "en"
},
"maxResults": {
"title": "Maximum products",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Stop the run after this many products saved; you are never charged for more. Products that do not exist, are no longer for sale or are not sold to the ship-to country are not saved and do not count. Default 100: caps the bill of a long list; at most 1,000, the most productUrls a run accepts. The form is prefilled with 3: a quick first run that stops after three of the five prefilled products.",
"default": 100
},
"maxVariants": {
"title": "Maximum variants per product",
"minimum": 0,
"maximum": 1000,
"type": "integer",
"description": "Variants (SKUs) kept in the variants column of each row, in AliExpress order; 0 keeps them all. Prices, stock and variantCount always cover every variant. Default 200: keeps the row of a product with thousands of SKUs to a manageable size.",
"default": 200
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Default: Apify residential proxies (RESIDENTIAL group, no country), required for AliExpress product pages and included in the price. Do not set a proxy country: the ship-to country above decides prices and shipping, whatever the IP. You can also provide your own residential proxy URLs.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
},
"concurrency": {
"title": "Parallel sessions",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Browsing sessions working at the same time, each on its own IP address, from 1 to 10. Default 4: the setting of our validation and control runs; lower it if many sessions are refused.",
"default": 4
},
"productsPerIp": {
"title": "Products per IP address",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Products fetched on one IP address before the scraper moves to a new one. AliExpress refuses an IP after about 6 products. Default 5: one below that limit, so that a session ends before its IP is refused.",
"default": 5
},
"delayMs": {
"title": "Delay between products",
"minimum": 0,
"maximum": 30000,
"type": "integer",
"description": "Pause between two requests of the same session, in milliseconds; 0 disables the pause. Default 1000: one second, the pace of our validation and control runs; raise it if many products are retried.",
"default": 1000
},
"maxRequests": {
"title": "Max requests",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Safety cap on the requests of one run, session openings included. Default 5000: far above what 1,000 products need.",
"default": 5000
},
"debugStoreResponses": {
"title": "Store raw responses",
"type": "boolean",
"description": "Debugging only: save every raw AliExpress response in the run's key-value store. Uses storage. Default false: the raw responses only help to diagnose a problem.",
"default": 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
}
}
}
}
}
}
}
}
}
}