{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper - Search, Products, Shipping & Reviews", "version": "0.1", "x-build-id": "lz4i8WlnCUuIGTgHL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jeanswiegers~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jeanswiegers-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/jeanswiegers~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-jeanswiegers-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/jeanswiegers~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-jeanswiegers-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search on AliExpress, e.g. \"wireless earbuds\". One search per keyword.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "searchUrls": { "title": "Search or category URLs", "type": "array", "description": "AliExpress search result or category page URLs (filters and sorting in the URL are kept), e.g. https://www.aliexpress.com/category/200000346/smart-watches.html", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 1200, "type": "integer", "description": "Stop each search or category after this many products (about 60 per page).", "default": 5 }, "scrapeSearchResultDetails": { "title": "Get full details for search results", "type": "boolean", "description": "Also scrape full product details (variants, store, shipping) for every search result. Each one is charged as a product.", "default": false }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "AliExpress product pages (e.g. https://www.aliexpress.com/item/1005006959700436.html) or bare product IDs. Returns full details plus shipping for each ship-to country.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "shipToCountries": { "title": "Ship-to countries", "type": "array", "description": "Two-letter country codes (US, GB, DE, ZA, BR, AU…). Shipping cost, delivery estimate and availability are returned for each. The first country also sets prices and search results.", "default": [ "US" ], "items": { "type": "string" } }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Reviews to scrape for each product (0 = none). 20 reviews per page.", "default": 0 }, "reviewsWithPhotosOnly": { "title": "Only reviews with photos", "type": "boolean", "description": "Return only reviews that include buyer photos.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency code for prices and shipping fees, e.g. USD, EUR, GBP, ZAR.", "default": "USD" }, "language": { "title": "Language", "type": "string", "description": "Locale for titles and texts, e.g. en_US, es_ES, fr_FR, de_DE, pt_BR.", "default": "en_US" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Products scraped in parallel. Keep low to avoid AliExpress rate limits.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Used only when needed. Search and reviews go out directly; product details try the run's own IP first and then rotate through these proxies, because AliExpress blocks its product API on most datacenter IPs. Keep the residential default for reliable product details.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }