{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper for Dropshipping - Exact Sales & Prices", "description": "Find winning AliExpress products by keyword: exact sales count (not '10,000+'), price, original price, discount, rating, Choice badge and delivery days. Rating and order-count filters run before saving, so skipped products are not billed. $3 per 1,000 products.", "version": "1.0", "x-build-id": "1j0zQxWk00hh0yBaC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/badr_xba~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-badr_xba-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/badr_xba~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-badr_xba-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/badr_xba~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-badr_xba-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": { "keywords": { "title": "Search terms", "type": "array", "description": "What to search for on AliExpress, one term per line, for example wireless earbuds. Each term is searched separately and every row says which term found it.", "items": { "type": "string" } }, "startUrls": { "title": "Search or category URLs", "type": "array", "description": "Optional. Paste AliExpress search or category pages, for example https://www.aliexpress.com/category/63705/earphones-headphones.html or a search page you already filtered on the site. Its own filters are kept.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Number of products", "minimum": 0, "type": "integer", "description": "Total products to return, shared evenly between your search terms and URLs. Set 0 for no limit: everything AliExpress shows, up to about 3,600 products per term (60 pages). Duplicates and products removed by your filters are never billed.", "default": 50 }, "country": { "title": "Deliver to", "enum": [ "US", "GB", "CA", "AU", "NZ", "FR", "DE", "ES", "IT", "NL", "BE", "PT", "PL", "AT", "CH", "IE", "SE", "NO", "DK", "FI", "IS", "CZ", "SK", "HU", "RO", "BG", "GR", "HR", "SI", "EE", "LV", "LT", "LU", "MT", "CY", "UA", "TR", "IL", "SA", "AE", "QA", "KW", "EG", "MA", "NG", "ZA", "BR", "MX", "AR", "CL", "CO", "PE", "JP", "KR", "IN", "ID", "MY", "PH", "SG", "TH", "VN", "TW", "HK" ], "type": "string", "description": "The market you shop from. It changes which products appear, their prices, delivery times and the ship-from warehouses.", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "CHF", "SEK", "NOK", "DKK", "ISK", "PLN", "CZK", "HUF", "RON", "BGN", "UAH", "TRY", "ILS", "SAR", "AED", "QAR", "KWD", "EGP", "MAD", "NGN", "ZAR", "BRL", "MXN", "ARS", "CLP", "COP", "PEN", "JPY", "KRW", "INR", "IDR", "MYR", "PHP", "SGD", "THB", "VND", "TWD", "HKD" ], "type": "string", "description": "Leave empty to use the currency of the country above (EUR for France, GBP for the UK…)." }, "language": { "title": "Language", "enum": [ "en_US", "fr_FR", "de_DE", "es_ES", "it_IT", "nl_NL", "pl_PL", "pt_BR", "ru_RU", "tr_TR", "ar_MA", "iw_IL", "ja_JP", "ko_KR", "th_TH", "vi_VN", "in_ID" ], "type": "string", "description": "Language of titles and labels. Leave empty to use the language of the country above." }, "sort": { "title": "Sort by", "enum": [ "relevance", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Best selling puts the products with the most orders first: the quickest way to find winning products.", "default": "relevance" }, "filters": { "title": "Filters", "type": "array", "description": "AliExpress filters, applied on the site before the products are read.", "items": { "type": "string", "enum": [ "free_shipping", "four_star_plus", "choice", "big_sale", "ships_from_local" ], "enumTitles": [ "Free shipping", "4 stars & up", "AliExpress Choice", "On sale", "Ships from my country" ] }, "default": [] }, "priceMin": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price to include, in the selected currency." }, "priceMax": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest price to include, in the selected currency." }, "shipFrom": { "title": "Ships from", "enum": [ "", "CN", "US", "ES", "FR", "DE", "PL", "IT", "NL", "BE", "CZ", "GB", "TR", "KR", "JP", "AU", "BR", "CA", "MX", "SA", "AE", "IL" ], "type": "string", "description": "Only products sent from this country, for example stock already in Europe or the US for fast delivery.", "default": "" }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional. Keep only one AliExpress category: copy a categoryId from a previous run." }, "minRating": { "title": "Minimum rating", "pattern": "^$|^[0-5](\\.[0-9])?$", "type": "string", "description": "Optional. Keep products rated at least this many stars, for example 4.5. Products below are skipped and not billed." }, "minOrders": { "title": "Minimum orders", "minimum": 0, "type": "integer", "description": "Optional. Keep products sold at least this many times (exact count). Products below are skipped and not billed." }, "includeAds": { "title": "Include sponsored products", "type": "boolean", "description": "Sponsored listings are flagged with isAd. Turn off to skip them (not billed).", "default": true }, "deduplicate": { "title": "Skip duplicates", "type": "boolean", "description": "A product found by several search terms is saved and billed once.", "default": true }, "maxResultsPerKeyword": { "title": "Products per search term", "minimum": 1, "type": "integer", "description": "Optional. Fixed number per term instead of sharing Number of products between them." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Keep the default. If AliExpress refuses a page, the Actor retries from new IP addresses and, if needed, from residential IPs in your market, at no extra cost to you.", "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 } } } } } } } } } }