{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper & API: Products, Variants, Shipping, Reviews", "description": "AliExpress scraper for search results and full product details: every variant with price and stock, all images, shipping to your country, store, specifications and reviews. Any country, currency and language.", "version": "0.1", "x-build-id": "4gKweMoxTGaa0cRTT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quarra~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quarra-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/quarra~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-quarra-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/quarra~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-quarra-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": { "searchQueries": { "title": "Search keywords or search URLs", "maxItems": 5000, "type": "array", "description": "One per line: keywords (wireless earbuds), or an AliExpress search or category URL pasted as is (its filters are kept). Each search returns products in AliExpress order, up to 'Max results per search'.", "items": { "type": "string", "maxLength": 2000 } }, "productUrls": { "title": "Product URLs or IDs", "maxItems": 5000, "type": "array", "description": "One per line: AliExpress product URLs (aliexpress.com/item/…, any country site, mobile links) or product IDs. Each gets the full details.", "items": { "type": "string", "maxLength": 2000 } }, "maxItems": { "title": "Max products", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Total number of products delivered by the run (search results and products with full details), counted exactly. Reviews are not counted here.", "default": 100 }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Products per search, at most 3,600 (AliExpress shows 60 pages of 60).", "default": 100 }, "scrapeDetails": { "title": "Full details for search results", "type": "boolean", "description": "Off: search results with title, price, rating, orders, images (charged as search results). On: every search result also gets the full product details: all variants with price and stock, all images, store, shipping, specifications (charged as products).", "default": false }, "sort": { "title": "Sort", "enum": [ "default", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of search results.", "default": "default" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Lowest price, in the run's currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Highest price, in the run's currency." }, "shipTo": { "title": "Ship to (country)", "maxLength": 2, "type": "string", "description": "Two-letter country code (US, GB, DE, FR, ES, BR…). Prices, availability and shipping are those for this country.", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RON", "BRL", "MXN", "CLP", "COP", "PEN", "JPY", "KRW", "INR", "IDR", "THB", "VND", "PHP", "MYR", "SGD", "HKD", "TWD", "ILS", "TRY", "SAR", "AED", "QAR", "KWD", "ZAR", "NGN", "EGP", "MAD", "UAH", "KZT", "RUB" ], "type": "string", "description": "Currency of every price.", "default": "USD" }, "language": { "title": "Language", "enum": [ "en", "fr", "de", "es", "it", "pt", "nl", "pl", "ru", "tr", "ja", "ko", "ar", "he", "th", "vi", "id" ], "type": "string", "description": "Language of titles and specifications (as translated by AliExpress).", "default": "en" }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also deliver the reviews of each product, one record per review (rating, text, date, variant, photos, country). Reviewer names are never collected.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Reviews per product, most relevant first.", "default": 20 }, "proxyConfiguration": { "title": "Connection", "type": "object", "description": "Connection. Keep the default (automatic). Costs are included in the price.", "default": { "useApifyProxy": true } }, "deliveryConnector": { "title": "Send results to your app (MCP connector: Notion, Slack…)", "type": "string", "description": "Pick one of your Apify MCP connectors: at the end of each run, a summary of the results (count, the first 25 with their links, a link to the full dataset) is posted there. With a schedule and 'Only new', you get each day's new results where your team works. Nothing is sent when a run finds nothing. Notion connects in one click; Slack and Google need your own OAuth app in Apify, or use the webhook field below." }, "deliveryTarget": { "title": "Where in the app (channel, page or sheet ID)", "type": "string", "description": "Slack channel ID (C0123…), Notion page ID, Google Sheet ID… Leave empty if the app needs no target (a new Notion page is then created at the top of your workspace)." }, "deliveryWebhookUrl": { "title": "Or a webhook URL (Slack, Discord, Make, Zapier, n8n)", "type": "string", "description": "No connector needed. A Slack Incoming Webhook (hooks.slack.com/…) gets a message, a Discord channel webhook gets a message, any other URL receives the summary as JSON (title, text, count, datasetUrl, items)." }, "deliveryTool": { "title": "Connector tool (advanced)", "type": "string", "description": "Name of the connector's tool to call. Leave empty: the best tool that posts a message, creates a page or appends rows is picked, and the run log lists every tool the connector offers." }, "deliveryArguments": { "title": "Connector tool arguments (advanced)", "type": "object", "description": "Extra arguments for the tool, merged last, for example {\"channel\": \"#reddit-leads\"} or {\"parent\": {\"database_id\": \"…\"}}." } } }, "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 } } } } } } } } } }