{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper — Products, Prices & Stores", "description": "Scrape AliExpress search results and product pages: price, original price, discount, rating, orders, shipping, SKUs, store name and rating, images. Any keyword, category URL or product URL.", "version": "0.1", "x-build-id": "hy3K1xzIMQ4BDUqPu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search on AliExpress, one per line (e.g. \"bluetooth speaker\", \"yoga mat\"). Each term is searched separately and paginated automatically (60 products per page).", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "AliExpress URLs to scrape instead of (or in addition to) search terms: search result pages (https://www.aliexpress.com/w/wholesale-led-strip.html), category pages (https://www.aliexpress.com/category/518/speakers.html) or single product pages (https://www.aliexpress.com/item/1005012781721732.html, returned with full details). aliexpress.us links work too.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many products in total (across all search terms and URLs). Keeps cost predictable.", "default": 100 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many result pages to open per search term or start URL (60 products each). AliExpress serves at most about 60-100 pages per query.", "default": 10 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Also open every product's page data to get all SKUs / variants with their own price and stock, the specification table, description text and images, shipping options with fees and delivery estimates, warranty / returns, video, and the store profile (name, URL, rating, positive feedback rate, followers, opening date). Slower and charged extra per product (see pricing).", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "ISO currency code for prices (USD, EUR, GBP, BRL, ...). AliExpress converts prices itself; some promotions differ by currency/country.", "default": "USD" }, "shipTo": { "title": "Ship-to country", "type": "string", "description": "Two-letter country code the products should be shippable to (US, DE, GB, BR, ...). Changes which products, prices and shipping options AliExpress shows.", "default": "US" }, "sortBy": { "title": "Sort by", "enum": [ "default", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Result order for search terms and search URLs: best match (default), most orders, or price ascending / descending. AliExpress offers no 'newest' sort.", "default": "default" }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. Compared: price, struck-through original price, currency and (product URLs / details) availability; order counts, ratings and delivery dates are ignored. With this on, Max items is the number of products checked each run (the watched window, e.g. the first 60 results), and product details are fetched only for new or changed products. For a steady watch, sort by Orders and keep the proxy in your Ship to country: AliExpress ranks and prices results differently per visitor location.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is recommended. AliExpress shows a slider captcha to suspicious traffic; if the run reports captcha pages, switch to residential proxies (ideally in the ship-to country).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }