{ "openapi": "3.0.1", "info": { "title": "AliExpress Products Scraper", "description": "AliExpress Scraper SD - AliExpress Scraper is an e-commerce data tool that extracts AliExpress search results by keyword, search or category URL: price, original price, rating, exact sold count, Choice and ad flags, images and ship-from, plus rating summaries and product reviews.", "version": "1.0", "x-build-id": "VzFwSmDau7qQfVgHa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-aliexpress-products-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/neuro-scraper~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-aliexpress-products-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/neuro-scraper~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-aliexpress-products-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": { "mode": { "title": "What to scrape", "enum": [ "products", "reviews" ], "type": "string", "description": "products = one row per product: search terms and search URLs give product cards (price, rating, sold count ...), an item URL or product id gives a product basics row (title, images, rating summary). reviews = one row per review, for every product given by URL/id or found by the search terms.", "default": "products" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What you would type in the AliExpress search box, one per line. Example: phone case", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress URLs or product ids (optional)", "type": "array", "description": "Search URLs (https://www.aliexpress.com/w/wholesale-phone-case.html or /wholesale?SearchText=phone+case, filters and sort in the URL are kept), category URLs (https://www.aliexpress.com/category/100003109/women-clothing.html), item URLs (https://www.aliexpress.com/item/1005007932835902.html) or bare product ids (1005007932835902). The kind is detected automatically.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum number of rows in total (products in products mode, reviews in reviews mode). Pagination continues page after page until this number is reached or AliExpress has no next page. Example: 100", "default": 20 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 60, "type": "integer", "description": "Safety cap on result pages read per search term or search URL. AliExpress serves at most 60 pages of 60 cards (3,600 products) per query. Example: 10", "default": 60 }, "sortBy": { "title": "Sort search results by", "enum": [ "best_match", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of the search results (AliExpress's own sort options). A sort already present in a pasted search URL wins.", "default": "best_match" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "BRL", "AUTO" ], "type": "string", "description": "Currency of the prices. It is set through AliExpress's own currency switcher at the start of each session. AUTO = AliExpress picks it from the visitor (proxy) IP.", "default": "USD" }, "shipToCountry": { "title": "Ship-to country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code AliExpress uses for availability, prices and shipping, set together with the currency. Example: US, DE, GB. Ignored when currency is AUTO.", "default": "US" }, "includeDetails": { "title": "Add rating summary per product (products mode)", "type": "boolean", "description": "For every search result, also load the public review summary: review count, positive rate and star counts (1 extra request per product; cards without a gallery also open the item page for it, 1 more request). Prices per variant, stock, seller/store and specifications need AliExpress's signed product API and are NOT included.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product (reviews mode)", "minimum": 1, "type": "integer", "description": "How many reviews to read per product, 20 per request, in AliExpress's default review order. Example: 100", "default": 50 }, "reviewsFilter": { "title": "Review filter (reviews mode)", "enum": [ "all", "image", "additional" ], "type": "string", "description": "all = every review; image = only reviews with photos; additional = only reviews with a follow-up (additional) feedback.", "default": "all" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended and is the default (US). The proxy country decides the currency only when currency is AUTO.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }