{ "openapi": "3.0.1", "info": { "title": "AliExpress Keyword Search Scraper: Rank, Orders & Delivery Data", "description": "Search AliExpress keywords in 16 ship-to markets and get ranked product rows with sale and list price, exact orders sold, rating, delivery window, ship-from country and Choice, Brand+ and sponsored badges. Filter by price, orders and delivery, and track new products and price drops between runs.", "version": "0.2", "x-build-id": "eRGPWqTgpqDtERKKD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~aliexpress-keyword-catalog-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-aliexpress-keyword-catalog-intelligence", "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/getascraper~aliexpress-keyword-catalog-intelligence/runs": { "post": { "operationId": "runs-sync-getascraper-aliexpress-keyword-catalog-intelligence", "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/getascraper~aliexpress-keyword-catalog-intelligence/run-sync": { "post": { "operationId": "run-sync-getascraper-aliexpress-keyword-catalog-intelligence", "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": "Keywords", "type": "array", "description": "One AliExpress search phrase per row. Each phrase is searched on its own and the results are combined into one catalog.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "sortBy": { "title": "Sort results by", "enum": [ "default", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of the AliExpress results. Rank in the output follows this order.", "default": "default" }, "maxItems": { "title": "Maximum products per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many matching products to save for each keyword. Scanning stops as soon as this many matches are found.", "default": 20 }, "maxPages": { "title": "Maximum pages to scan per keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Each AliExpress results page holds up to 60 products. Raise this when you use strict filters so more pages are checked for matches.", "default": 5 }, "shipTo": { "title": "Ship to country", "enum": [ "US", "CA", "GB", "DE", "FR", "ES", "IT", "NL", "PL", "SE", "AU", "BR", "SA", "IL", "JP", "KR" ], "type": "string", "description": "The destination market. It decides the currency, prices, delivery estimates and language of titles. Markets other than the United States use residential connections.", "default": "US" }, "shipFrom": { "title": "Ships from country", "enum": [ "any", "CN", "US", "GB", "DE", "FR", "ES", "IT", "NL", "PL", "BR" ], "type": "string", "description": "Keep only products dispatched from this country, as shown on the listing. Most products ship from China or from a local warehouse in the destination country.", "default": "any" }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Return only products that AliExpress marks with free shipping.", "default": false }, "localWarehouseOnly": { "title": "Local warehouse only", "type": "boolean", "description": "Return only products from the Local+ program, which ship from a warehouse inside the destination country.", "default": false }, "maxDeliveryDays": { "title": "Maximum delivery days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Drop products whose estimated delivery takes longer than this many days. Leave empty for no limit." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Lowest sale price to keep, in the currency of the chosen market. Leave empty for no lower limit." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Highest sale price to keep, in the currency of the chosen market. Leave empty for no upper limit." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only products with at least this star rating (0 to 5). Products without a rating are dropped when this is set." }, "minOrders": { "title": "Minimum orders sold", "minimum": 0, "type": "integer", "description": "Keep only products with at least this many orders sold. This is a strong signal of proven demand." }, "minDiscountPercent": { "title": "Minimum discount percent", "minimum": 0, "maximum": 99, "type": "integer", "description": "Keep only products discounted by at least this percent from their list price." }, "choiceOnly": { "title": "AliExpress Choice only", "type": "boolean", "description": "Return only products with the Choice badge.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Return only products that are part of an AliExpress sale event.", "default": false }, "brandPlusOnly": { "title": "Brand+ only", "type": "boolean", "description": "Return only products with the Brand+ top-brand badge.", "default": false }, "excludeSponsored": { "title": "Exclude sponsored results", "type": "boolean", "description": "Remove paid ad placements so only organic results remain.", "default": false }, "titleIncludes": { "title": "Title must include one of", "type": "array", "description": "Keep a product only if its title contains at least one of these words or phrases. Leave empty to keep all.", "default": [], "items": { "type": "string" } }, "titleExcludes": { "title": "Title must not include", "type": "array", "description": "Drop products whose title contains any of these words or phrases, for example case or cover.", "default": [], "items": { "type": "string" } }, "dedupeAcrossKeywords": { "title": "Remove duplicates across keywords", "type": "boolean", "description": "When the same product matches several keywords, return it once and list its rank for each keyword.", "default": true }, "includeGallery": { "title": "Include all gallery images", "type": "boolean", "description": "Add the extra product photos shown on each result card. The main image is always included.", "default": false }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Compare this run with the previous run of the same scope. Each row gets a change type, price change, rank change and orders gained.", "default": false }, "onlyChanges": { "title": "Return only new or repriced products", "type": "boolean", "description": "With change tracking on, keep only products that are new or whose price changed. Everything else is skipped.", "default": false }, "monitorScope": { "title": "Tracking name", "type": "string", "description": "A label for this watch. Use the same name on every scheduled run you want compared, and a different name for a separate watch.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Connection used to reach AliExpress. The default works for the United States market. Other markets switch to residential connections automatically.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "BUYPROXIES94952" ] } } } }, "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 } } } } } } } } } }