{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper — Prices and Promotion Context", "description": "Collect AliExpress keyword listings with displayed prices, currency, ratings, sales badges and promotion conditions. Independent search tool with locale checks and bounded diagnostics.", "version": "0.3", "x-build-id": "7U7CurpuhtGOSwfYi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peerless_columbine~independent-aliexpress-research/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peerless_columbine-independent-aliexpress-research", "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/peerless_columbine~independent-aliexpress-research/runs": { "post": { "operationId": "runs-sync-peerless_columbine-independent-aliexpress-research", "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/peerless_columbine~independent-aliexpress-research/run-sync": { "post": { "operationId": "run-sync-peerless_columbine-independent-aliexpress-research", "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 keywords", "maxItems": 10, "type": "array", "description": "One or more product keywords to search on AliExpress (e.g. 'smartphone', 'wireless earbuds', 'phone case').", "items": { "type": "string" } }, "sort": { "title": "Sort order", "enum": [ "default", "orders", "price_asc", "price_desc", "rating" ], "type": "string", "description": "How to sort the search results page.", "default": "default" }, "minPrice": { "title": "Minimum price", "type": "number", "description": "Only include products priced at or above this value. Applies to the raw displayed promotional value; not a verified ordinary single-item or checkout price. See priceContext." }, "maxPrice": { "title": "Maximum price", "type": "number", "description": "Only include products priced at or below this value. Applies to the raw displayed promotional value; not a verified ordinary single-item or checkout price. See priceContext." }, "minRating": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only include products with a star rating at or above this value (0 to 5)." }, "minOrders": { "title": "Minimum orders", "minimum": 0, "type": "integer", "description": "Only include products with at least this many orders sold." }, "maxItems": { "title": "Max items per keyword", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of products to collect per keyword.", "default": 48 }, "maxPages": { "title": "Max pages per keyword (optional)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard cap on pages scraped per keyword. Leave blank to auto-paginate based on Max items (recommended)." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 30, "maximum": 180, "type": "integer", "description": "Per-request timeout in seconds. Increase if you see timeout errors.", "default": 60 }, "searchQueries": { "title": "searchQueries", "maxItems": 10, "type": "array", "description": "Optional secondary-contract alias of keywords. Conflicting aliases are rejected.", "items": { "type": "string" } }, "productUrls": { "title": "productUrls", "maxItems": 10, "type": "array", "description": "Public AliExpress item URLs or page-one search URLs. Tracking spm is ignored; pass other filters explicitly.", "items": { "type": "string" } }, "maxProducts": { "title": "maxProducts", "minimum": 50, "maximum": 1000, "type": "integer", "description": "Secondary contract per-query limit; default 50 when searchQueries is used." }, "sortBy": { "title": "sortBy", "enum": [ "default", "price_asc", "price_desc", "orders" ], "type": "string", "description": "Secondary-contract alias of sort." }, "proxyConfiguration": { "title": "proxyConfiguration", "type": "object", "description": "User-owned proxy configuration; off by default. May incur charges in your account. Never silently falls back.", "default": { "useApifyProxy": false } }, "useProxy": { "title": "useProxy", "type": "boolean", "description": "Alias enabling your Apify proxy. Omit when proxyConfiguration explicitly selects a mode." }, "country": { "title": "country", "type": "string", "description": "Optional requested destination ISO country. Generates only the public region preference; never inferred from language/currency. Strict matching requires source destination metadata." }, "currency": { "title": "currency", "type": "string", "description": "Optional requested ISO currency. Generates only the public currency preference; source currency must match, with no conversion or relabeling." }, "language": { "title": "language", "enum": [ "en", "de", "es", "fr", "pt", "it", "nl", "ja", "ko" ], "type": "string", "description": "An explicit language generates the documented public site/buyer-locale preferences. No destination or currency is inferred. Strict source locale checking remains enabled." }, "requireLocaleMatch": { "title": "requireLocaleMatch", "type": "boolean", "description": "Reject unverified or mismatched explicit locale requests. False retains source values with visible provenance gaps.", "default": true }, "includeVariants": { "title": "includeVariants", "type": "boolean", "description": "Fetch item details; requires real SKU ids, prices and properties. Missing SKU data is a target failure.", "default": false }, "outputFormat": { "title": "outputFormat", "enum": [ "kawsar", "devcake" ], "type": "string", "description": "kawsar preserves tags as array; devcake uses its documented flat names and string tags.", "default": "kawsar" }, "maxConcurrency": { "title": "maxConcurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Concurrent targets and maximum HTTP connections; validated range 1 to 8.", "default": 2 }, "maxRetries": { "title": "maxRetries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Retries only network/429/5xx failures; never retry or solve a challenge.", "default": 1 }, "maxRunSeconds": { "title": "maxRunSeconds", "minimum": 10, "maximum": 110, "type": "integer", "description": "Whole collection time budget, leaving room for storage within a 120-second run.", "default": 95 }, "dnsMode": { "title": "dnsMode", "enum": [ "system", "google-doh" ], "type": "string", "description": "system by default. Explicit google-doh uses fixed public DNS with TLS and public-IP validation.", "default": "system" } } }, "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 } } } } } } } } } }