{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper — Prices, Orders, Ratings", "description": "AliExpress global product search from aliexpress.com by keyword: sale price, original price, discount, currency, order count, rating, image, item URL, search position, sponsored flag, free shipping, delivery estimate. Sort by orders or price, filter by price range. Pay per result, no login.", "version": "0.0", "x-build-id": "SME86fswXbMuLGIrM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/architekture~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-architekture-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/architekture~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-architekture-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/architekture~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-architekture-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search terms", "maxItems": 100, "type": "array", "description": "Product keywords, searched on aliexpress.com exactly as a shopper would type them. Up to 100 per run.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max products per search term", "minimum": 0, "maximum": 3600, "type": "integer", "description": "Stop each search term after this many products. 0 = as many as AliExpress lists (60 per page, at most 60 pages = 3,600). Products already returned for an earlier term are not repeated.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "default", "orders", "priceAsc", "priceDesc" ], "type": "string", "description": "AliExpress sort order. 'orders' = most sold first. On page 1 of each keyword the actor checks AliExpress confirmed the sort, and warns in RUN_SUMMARY if it did not.", "default": "default" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Only products whose lowest sale price is at least this amount, in the listing currency (USD on the default proxy). Applied by AliExpress; 0 means no minimum." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Only products whose lowest sale price is at most this amount (must be above 0). Applied by AliExpress." }, "incrementalMode": { "title": "Incremental: only new products", "type": "boolean", "description": "Requires stateKey. Delivers only products (itemId) not delivered before under this stateKey. Products already delivered are skipped and not charged, even if their price moved: AliExpress shows different prices to different visitors minutes apart. maxItemsPerQuery then bounds the watched window (the first N products per keyword).", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Any name (e.g. my-earphones). Keeps saved progress and the incremental baseline in your account, isolated per key. Use a different key for different inputs.", "default": "" }, "continuePreviousRun": { "title": "Continue saved collection", "type": "boolean", "description": "Resume an unfinished collection saved under stateKey (after a spending limit, timeout, abort or platform migration). Delivered products are not delivered or charged again.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy in the US is the tested default: AliExpress lists prices in the currency of the request's country, so US = USD (and minPrice/maxPrice are read in that currency). The actor switches IP every 4 requests to stay under AliExpress's limit. Choose RESIDENTIAL if runs report 'blocked' terms.", "default": { "useApifyProxy": true, "apifyProxyCountry": "US" } }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "Tell the maintainers what you needed and did not get. Read by a human; does not change the output." } } }, "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 } } } } } } } } } }