{ "openapi": "3.0.1", "info": { "title": "AliExpress Products Scraper", "description": "Scrape AliExpress search and category pages for product prices, ratings, sales signals, shipping details, and seller URLs.", "version": "0.1", "x-build-id": "sS6thOiDOb3b9Bxz8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~aliexpress-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~aliexpress-products-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~aliexpress-products-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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": { "query": { "title": "Search query", "type": "string", "description": "AliExpress keyword, for example laptop or phone case (up to 200 characters). Used only when startUrls is empty. Omitted or blank query with no start URLs searches for laptop; prefill is a form example, not a required API input." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional credential-free HTTPS AliExpress listing URLs. Non-empty startUrls takes precedence over query; each supplied page is read once, without automatic page traversal. Query-based sorting, locale and price settings do not modify supplied URLs. Clear the form's example URL to search using query.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum total product rows to save across all inputs: 1–1,000, default 50. The form prefill is 20. Fewer rows may be available; cards without a usable price are skipped.", "default": 50 }, "shipToCountry": { "title": "Ship-to country", "type": "string", "description": "Two-letter destination preference, such as US or GB, for query-built search URLs only. Not a guaranteed regional catalog: a later attempt may omit locale parameters. Supplied startUrls are unchanged." }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency preference, such as USD or EUR, for query-built search URLs only. Not currency conversion or a guarantee: locale parameters may be omitted on a later attempt. Check each row's currency; supplied startUrls are unchanged." }, "sort": { "title": "Sort order", "enum": [ "relevance", "orders_desc", "price_asc", "price_desc" ], "type": "string", "description": "Sorting preference sent to AliExpress for query-built URLs: best match (default), most orders, price ascending or price descending. Results retain served page order, not a guaranteed global ranking. Does not modify startUrls.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Non-negative minimum price preference sent with query-built search URLs only. Must not exceed maxPrice. Not a post-extraction filter or guaranteed price bound; inspect returned prices." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Non-negative maximum price preference sent with query-built search URLs only. Must not be below minPrice. Not a post-extraction filter or guaranteed price bound; inspect returned prices." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional settings for primary listing requests. Omitted settings or useApifyProxy: false without proxyUrls use direct access; there is no automatic managed-proxy escalation. useApifyProxy: true uses managed proxy groups/country available to your account, which may incur proxy charges. Non-empty proxyUrls uses your supplied proxies when managed proxy is off; useApifyProxy: false alone does not override supplied proxyUrls. Managed proxy takes precedence if both are supplied. The alternate listing retrieval route does not use this configuration, so it is not an all-requests proxy guarantee. Malformed flags, groups, country codes or proxy URLs are rejected rather than enabling managed proxy. Never include proxy credentials in support reports." } } }, "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 } } } } } } } } } }