{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper — Products, Reviews & Sellers", "description": "Scrape AliExpress product listings, full product details (specs, SKU variants, images), customer reviews, and seller data. Search by keyword or paste product/search URLs - the Actor auto-detects what to scrape. Pay-per-event pricing.", "version": "1.0", "x-build-id": "wbg4CW711H3DQrQCZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~aliexpress-all-in-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-aliexpress-all-in-one-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/khadinakbar~aliexpress-all-in-one-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-aliexpress-all-in-one-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/khadinakbar~aliexpress-all-in-one-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-aliexpress-all-in-one-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": { "searchQuery": { "title": "Search keyword", "type": "string", "description": "Free-text keyword to search AliExpress products (e.g. 'wireless earbuds'). The Actor opens the AliExpress search results page and collects product listing cards. Leave empty if you instead provide startUrls. NOT a product URL - to scrape one product, paste its URL into Start URLs." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "List of AliExpress URLs to scrape. Supports search/category URLs (https://www.aliexpress.com/w/wholesale-...html) and product URLs (https://www.aliexpress.com/item/100500XXXXXXXXX.html). The Actor auto-detects each URL type. Use this instead of, or together with, searchQuery. NOT for store-only URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of dataset records to return across listings and products (reviews are counted separately under maxReviews). The Actor stops and exits once this cap is reached, so it doubles as your cost ceiling. Defaults to 50. Set higher for bulk research.", "default": 50 }, "detailedItems": { "title": "Scrape full product details", "type": "boolean", "description": "When enabled, the Actor visits each product page to attempt full detail extraction (specifications, SKU/variant options, full image gallery, seller details). Best-effort: AliExpress aggressively guards product pages, so when a page cannot be fully read the record falls back to the rich listing data (title, price, discount, rating, orders, images) and is billed at the standard rate, never the higher 'detailed-result' rate. Listings and reviews are unaffected. Default false.", "default": false }, "includeReviews": { "title": "Include customer reviews", "type": "boolean", "description": "When enabled, customer reviews are collected for each scraped product (up to maxReviews per product) and emitted as separate review records with rating, text, country, date, and review images. Applies to product URLs and, when detailedItems is on, to searched products. Default false.", "default": false }, "maxReviews": { "title": "Max reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of customer reviews to collect per product when includeReviews is enabled. Each review is one dataset record billed at the standard 'result' rate. Defaults to 20. Ignored when includeReviews is off.", "default": 20 }, "site": { "title": "AliExpress domain", "enum": [ "aliexpress.com", "aliexpress.us", "de.aliexpress.com", "fr.aliexpress.com", "es.aliexpress.com", "it.aliexpress.com", "pt.aliexpress.com", "ru.aliexpress.com" ], "type": "string", "description": "Which AliExpress regional domain to scrape. Affects language and default currency of returned data. Use 'aliexpress.com' (global English) unless you need region-specific pricing. Default 'aliexpress.com'.", "default": "aliexpress.com" }, "shipCountry": { "title": "Ship-to country", "type": "string", "description": "Two-letter ISO country code used as the ship-to country and the residential proxy country (e.g. 'US', 'GB', 'DE'). Affects shipping options and which prices AliExpress shows. Defaults to 'US'.", "default": "US" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended - AliExpress blocks datacenter IPs. Defaults to Apify residential proxy pinned to the ship-to country. Leave default unless you have a specific requirement.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }