{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper - Products, Prices, Orders & Ratings", "description": "Scrape AliExpress search results by keyword: product title, price, original price, discount, number sold, rating, images, shipping and delivery days. Choose currency, ship-to country, sort and price range. No login needed.", "version": "1.0", "x-build-id": "VMSSNwXGSCqCr5Xaf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pipiagent~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pipiagent-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/pipiagent~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-pipiagent-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/pipiagent~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-pipiagent-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "What you would type into the AliExpress search box. One search per keyword, for example \"phone case\" or \"bluetooth speaker\".", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 3600, "type": "integer", "description": "How many products to save for each keyword. AliExpress shows 60 products per page and at most 60 pages (about 3,600 products) per search.", "default": 100 }, "maxItems": { "title": "Max results in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The run stops after saving this many products across all keywords.", "default": 1000 }, "sort": { "title": "Sort by", "enum": [ "bestMatch", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "The same sort options as the AliExpress search page.", "default": "bestMatch" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Only products priced at or above this amount, in the currency you choose below. Leave empty for no minimum." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Only products priced at or below this amount, in the currency you choose below. Leave empty for no maximum." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "KRW", "BRL", "MXN", "PLN", "TRY", "INR", "CHF", "SEK", "NZD", "ILS", "SAR", "AED", "THB", "PHP", "IDR", "MYR", "VND", "CLP", "COP", "UAH", "KZT" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "shipTo": { "title": "Ship to country", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "BE", "PL", "SE", "CH", "AT", "PT", "IE", "CA", "AU", "NZ", "JP", "KR", "BR", "MX", "CL", "CO", "TR", "IL", "SA", "AE", "IN", "TH", "PH", "ID", "MY", "SG", "VN", "UA", "KZ" ], "type": "string", "description": "Prices, shipping and delivery times are shown for this country, as a shopper there would see them. Some products are only offered in some countries.", "default": "US" }, "includeAds": { "title": "Include sponsored products", "type": "boolean", "description": "AliExpress mixes a few sponsored (ad) products into search results. Turn this off to skip them. Every record has an \"isAd\" field either way.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Leave it off: when AliExpress starts showing captcha pages, the Actor switches to Apify datacenter proxy addresses on its own.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }