{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper - Products and Prices", "description": "AliExpress search scraper, no login: products and prices by keyword, search link, category or store, in the ship-to country, currency and language you pick. Rows carry price, list price, discount, units sold, rating and delivery; add variant prices and stock, shipping, store and reviews.", "version": "0.1", "x-build-id": "1SlAMLJKJxgjw8l99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-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/automation_craft~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-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/automation_craft~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-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 words", "type": "array", "description": "Words to search on AliExpress, one search each, as you would type them in the AliExpress search box (for example \"wireless earbuds\"). Up to 100 searches and links per run.", "items": { "type": "string" } }, "startUrls": { "title": "AliExpress links", "type": "array", "description": "Search links (aliexpress.com/w/wholesale-..., aliexpress.us, country sites such as fr.aliexpress.com), category links (aliexpress.com/category//...), store links (aliexpress.com/store/, every product of the store), product links (aliexpress.com/item/.html) and short links (a.aliexpress.com). The filters a search link carries (sort, price, switches, attributes, ship-from, category, page) are applied; a setting you give below replaces only that one filter of the link.", "items": { "type": "string" } }, "storeSearch": { "title": "Search inside stores", "type": "string", "description": "Words searched inside each store link (AliExpress's own search within a store), for example \"case\". Left empty, a store link lists all its products." }, "productIds": { "title": "Product ids or links", "type": "array", "description": "AliExpress product ids (1005... or the 3256... form of aliexpress.us) or product links. Each is read through the product detail and delivered as one product row with variants, shipping and store, charged as Product detail.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most products this run delivers over all searches and links (default 100). AliExpress shows at most 60 pages of 60 products per search." }, "maxItemsPerSearch": { "title": "Maximum products per search", "minimum": 1, "maximum": 3600, "type": "integer", "description": "The most products one search or link delivers. Left empty, only the run maximum applies." }, "maxPages": { "title": "Pages per search", "minimum": 1, "maximum": 125, "type": "integer", "description": "How many result pages each search or store link reads at most (a search page holds 60 products and AliExpress shows at most 60; a store page holds 40 and a store shows about 121). Default: all." }, "startPage": { "title": "First page", "minimum": 1, "maximum": 60, "type": "integer", "description": "The result page each search starts on (default 1, or the page of a pasted link)." }, "shipTo": { "title": "Ship to country", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BE", "PL", "PT", "SE", "DK", "FI", "NO", "IE", "AT", "CH", "CZ", "GR", "RO", "HU", "SK", "BG", "HR", "SI", "LT", "LV", "EE", "LU", "CY", "MT", "IS", "CA", "AU", "NZ", "BR", "MX", "CL", "CO", "AR", "PE", "UY", "EC", "BO", "PY", "CR", "PA", "DO", "GT", "PR", "JP", "KR", "SG", "MY", "TH", "VN", "ID", "PH", "IN", "PK", "BD", "LK", "IL", "AE", "SA", "QA", "KW", "BH", "OM", "JO", "LB", "TR", "UA", "MD", "GE", "AM", "AZ", "KZ", "UZ", "ZA", "NG", "EG", "MA", "TN", "DZ", "KE", "GH", "HK", "TW", "MO" ], "type": "string", "description": "The country AliExpress prices and ships for (default United States). Search results, prices, shipping fees and delivery days follow it." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "BRL", "MXN", "CLP", "COP", "ARS", "PEN", "JPY", "KRW", "SGD", "MYR", "THB", "VND", "IDR", "PHP", "INR", "PKR", "ILS", "AED", "SAR", "TRY", "UAH", "ZAR", "NGN", "EGP", "MAD", "KZT", "PLN", "CZK", "HUF", "RON", "BGN", "SEK", "DKK", "NOK", "CHF", "HKD", "TWD", "QAR", "KWD" ], "type": "string", "description": "The currency of every price (default USD)." }, "language": { "title": "Language", "enum": [ "en_US", "fr_FR", "de_DE", "es_ES", "it_IT", "nl_NL", "pt_BR", "pl_PL", "ru_RU", "tr_TR", "ja_JP", "ko_KR", "ar_MA", "iw_IL", "th_TH", "vi_VN", "in_ID" ], "type": "string", "description": "The language of titles and texts (default English). Prices do not change with it." }, "sort": { "title": "Sort by", "enum": [ "bestMatch", "orders", "priceAsc", "priceDesc", "newest" ], "type": "string", "description": "The order of results (default best match). Price orders are sorted within each page, as AliExpress sorts them. A store link takes best match or newest only (AliExpress ignores the other orders on store pages; a store asked for one gets a free row)." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Products from this price, in the run currency (up to two decimals). Each delivered product is checked against it too." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Products up to this price, in the run currency (up to two decimals). Each delivered product is checked against it too." }, "freeShipping": { "title": "Free shipping", "type": "boolean", "description": "Only products AliExpress lists under its free shipping filter." }, "choiceOnly": { "title": "Choice products only", "type": "boolean", "description": "Only AliExpress Choice products." }, "localWarehouse": { "title": "Ships from a local warehouse", "type": "boolean", "description": "Only products AliExpress ships from a warehouse in or near the ship-to country (its \"Local+\" filter, offered for some countries)." }, "onSale": { "title": "On sale", "type": "boolean", "description": "AliExpress's sale filter. It returns very few products outside sale events." }, "fourStarsAndUp": { "title": "Four stars and up", "type": "boolean", "description": "AliExpress's four stars and up filter (it narrows a search to a few hundred products)." }, "sevenDayDelivery": { "title": "Seven day delivery", "type": "boolean", "description": "AliExpress's seven day delivery filter (offered for the United Kingdom only)." }, "shipFrom": { "title": "Ships from", "type": "string", "description": "A two-letter country code (or EU) of the country the products ship from. AliExpress offers a few such values per ship-to country (United States: US; Germany: DE, EU, CN and others); a value it does not offer is reported in a free row." }, "categoryId": { "title": "Category id", "type": "string", "description": "An AliExpress category number (from a category link, for example 44 in aliexpress.com/category/44/...). With search words, the search stays inside the category; without search words, use a category link above." }, "attributes": { "title": "Attribute filters", "type": "array", "description": "AliExpress attribute filter codes as they appear in a search link (attr=2250-4169245), one per line, for example a brand or a cable length. Up to 10.", "items": { "type": "string" } }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only products rated at least this many stars (products without a rating are left out)." }, "minSold": { "title": "Minimum units sold", "minimum": 0, "type": "integer", "description": "Only products with at least this many units sold (AliExpress's own count where the page carries it, else the number in its label such as 10,000+)." }, "excludeSponsored": { "title": "Leave out sponsored products", "type": "boolean", "description": "Leave out the products AliExpress marks as ads on its result pages. Every row says whether it was sponsored." }, "excludeGiftOffers": { "title": "Leave out free gift offers", "type": "boolean", "description": "Leave out the \"free with any purchase\" gift cards that carry no price of their own." }, "includeDetails": { "title": "Product details", "type": "boolean", "description": "Read each product's detail record: every variant with its price, list price and stock, shipping options with fee and delivery days to the ship-to country, the store with its ratings and followers, specifications, images, video and wishlist count. Charged as Product detail, only for products AliExpress ships to the ship-to country." }, "includeDescription": { "title": "Description text", "type": "boolean", "description": "With product details: the seller's description as text with its images (one more read per product, no extra charge)." }, "includeReviews": { "title": "Reviews", "type": "boolean", "description": "Read each product's reviews: stars, date, text and English translation, buyer country, the variant bought and photos, plus the product's star breakdown. Charged per review delivered." }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most reviews read per product (default 20, up to 5,000: every review AliExpress lists for most products)." }, "reviewsFilter": { "title": "Which reviews", "enum": [ "all", "withPhotos", "additional", "local" ], "type": "string", "description": "The reviews AliExpress lists (default all)." }, "reviewsSort": { "title": "Review order", "enum": [ "default", "newest" ], "type": "string", "description": "The order reviews are read in (default AliExpress's own order); newest first reads the latest reviews." }, "includePersonalData": { "title": "Include personal data", "type": "boolean", "description": "Adds the reviewer's gender and profile photo to review rows (off by default; the masked reviewer name AliExpress shows is always delivered). You are responsible for a lawful use of personal data, GDPR included." }, "memoryName": { "title": "Memory name (monitor)", "type": "string", "description": "A name of your choice. Products delivered under this name are remembered per ship-to country and currency; later runs deliver and charge only products not delivered before (or, with price changes on, products whose price changed). A run with a memory name also pays a small Search page event per results page with products it reads, and a Store page event per page of a store's list. A memory belongs to this Actor and to your account." }, "monitorMode": { "title": "What counts as new", "enum": [ "new", "newAndPriceChanges" ], "type": "string", "description": "With a memory name: deliver new products only (default), or also products whose price changed since they were delivered (with the previous price)." }, "resetMemory": { "title": "Reset the memory", "type": "boolean", "description": "Forget every product remembered under the memory name before this run (applied once, on a fresh run)." }, "includeRaw": { "title": "Raw card data", "type": "boolean", "description": "Adds AliExpress's own search card object to each product row under raw (for developers)." } } }, "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 } } } } } } } } } }