{ "openapi": "3.0.1", "info": { "title": "AliExpress Products Scraper", "description": "Scrape products from AliExpress (aliexpress.com) search results and product pages: title, price, discount, rating, sold count, store, variants and SKUs, stock, shipping, specifications and images. Export JSON, CSV or Excel.", "version": "1.0", "x-build-id": "k68wGxwM3ThhnDv72" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-aliexpress-products-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/confidential_gnat~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-aliexpress-products-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/confidential_gnat~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-aliexpress-products-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": { "startUrls": { "title": "Search or product URLs", "type": "array", "description": "AliExpress search result pages or single product pages, for example https://www.aliexpress.com/w/wholesale-phone-case.html?SearchText=phone+case or https://www.aliexpress.com/item/1005013193921858.html. Filters already in the URL are kept. When empty, the keyword below is used.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items per search", "minimum": 1, "type": "integer", "description": "Maximum products saved for each search URL. The site shows at most 3,600 results per search; above that the search is split automatically into price windows.", "default": 5 }, "scrapeDetails": { "title": "Scrape product pages", "type": "boolean", "description": "Open every product for the store, variants and SKUs, stock, shipping, specifications and all images. Turn off to save only what the search results show (price, rating, sold count): much faster and cheaper.", "default": true }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new products and price changes. Products already seen with the same price are skipped and not charged. Each record gets a changeType: new or price_change." }, "keyword": { "title": "Keyword", "type": "string", "description": "Search words, for example phone case or wireless earbuds." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Only products priced at or above this amount, in the currency chosen below." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Only products priced at or below this amount, in the currency chosen below." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "BRL", "MXN", "INR", "JPY", "KRW", "PLN", "TRY", "SAR", "AED", "SGD" ], "type": "string", "description": "Currency of all prices.", "default": "USD" }, "shipToCountry": { "title": "Ship to country", "type": "string", "description": "Two-letter country code the shipping fee and delivery time are calculated for, for example US, GB, DE, FR or BR.", "default": "US" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Product pages are only served to some proxy addresses, so the actor tries several; datacenter proxies are enough and cheapest. Searching without product pages also works without a proxy.", "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 } } } } } } } } } }