{ "openapi": "3.0.1", "info": { "title": "AliExpress Product Search Scraper & API - Prices, Orders", "description": "AliExpress scraper for product research and dropshipping: search by keyword, search URL or category and get price, original price, discount, rating, exact orders sold, store, Choice and ad flags, delivery days, images and URL. Any ship-to country and currency. 1,000 products = $1.50.", "version": "1.0", "x-build-id": "ipWMhZzlXcAmcTgCE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-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/rel8ble~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-rel8ble-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/rel8ble~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-rel8ble-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "Provide these or searchUrls. One search per line, written as you would type it into the AliExpress search box: \"phone case\", \"mechanical keyboard\", \"led strip lights\". Each keyword returns up to maxItemsPerSearch products, sorted by sort and filtered by the price / shipping settings below. Default [\"phone case\"] (demo).", "items": { "type": "string" } }, "searchUrls": { "title": "AliExpress search or category URLs (alternative to keywords)", "type": "array", "description": "Optional. Full AliExpress URLs, one per line: search pages (https://www.aliexpress.com/w/wholesale-phone-case.html?SortType=total_tranpro_desc) or category pages (https://www.aliexpress.com/category/100003109/women-clothing.html). Filters already in the URL are kept; sort, price and shipping settings below do not apply to URLs. aliexpress.us links are accepted and read from aliexpress.com.", "items": { "type": "string" } }, "sort": { "title": "Sort order (for keywords)", "enum": [ "relevance", "orders", "price-asc", "price-desc", "newest" ], "type": "string", "description": "Optional. \"relevance\" (AliExpress Best Match, default), \"orders\" (most orders first - best for finding proven sellers), \"price-asc\", \"price-desc\", \"newest\".", "default": "relevance" }, "minPrice": { "title": "Min price (for keywords)", "minimum": 0, "type": "integer", "description": "Optional. Lowest price in the chosen currency, whole units (e.g. 5). Empty = no minimum." }, "maxPrice": { "title": "Max price (for keywords)", "minimum": 0, "type": "integer", "description": "Optional. Highest price in the chosen currency, whole units (e.g. 50). Empty = no maximum." }, "freeShippingOnly": { "title": "Free shipping only (for keywords)", "type": "boolean", "description": "Optional boolean. true = only products with free shipping to shipToCountry. Default false.", "default": false }, "choiceOnly": { "title": "AliExpress Choice only (for keywords)", "type": "boolean", "description": "Optional boolean. true = only AliExpress Choice products (faster, consolidated delivery). Default false.", "default": false }, "shipToCountry": { "title": "Ship-to country", "type": "string", "description": "Optional. Two-letter country code that prices, shipping and delivery estimates are calculated for: \"US\", \"GB\", \"DE\", \"FR\", \"ES\", \"IT\", \"NL\", \"PL\", \"CA\", \"AU\", \"BR\", \"MX\", \"KR\", \"JP\", \"SA\", \"AE\", \"IL\"... Default \"US\".", "default": "US" }, "currency": { "title": "Currency", "type": "string", "description": "Optional. Three-letter currency code for prices: \"USD\" (default), \"EUR\", \"GBP\", \"CAD\", \"AUD\", \"BRL\", \"PLN\", \"KRW\", \"JPY\"... Min/max price filters use this currency too.", "default": "USD" }, "maxItemsPerSearch": { "title": "Max products per search", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Optional. Products to save per keyword or URL, integer 1-3600. Default 60 (one page). AliExpress shows 60 products per page and up to 60 pages; set 20 for a quick answer, 600 for a deep sweep. Ads and organic results count together.", "default": 60 }, "includeAds": { "title": "Include ads", "type": "boolean", "description": "Optional boolean. true (default) = keep promoted (ad) listings, flagged isAd: true. false = organic results only.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional, advanced. Parallel requests, integer 1-20. Default 5.", "default": 5 }, "maxRequestRetries": { "title": "Max retries per page", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional, advanced. Retries per page on a new IP when AliExpress blocks or times out. Default 8.", "default": 8 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Apify Proxy (datacenter) works for AliExpress and is the default. Switch to the RESIDENTIAL group if you see repeated captcha retries.", "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 } } } } } } } } } }