{ "openapi": "3.0.1", "info": { "title": "[$1.00/1k] AliExpress Everything", "description": "Collect AliExpress listings, product details, variants, seller data, and reviews.", "version": "0.1", "x-build-id": "h63zyfDyJi8RmvY7y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cocoa_kit~aliexpress-everything/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cocoa_kit-aliexpress-everything", "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/cocoa_kit~aliexpress-everything/runs": { "post": { "operationId": "runs-sync-cocoa_kit-aliexpress-everything", "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/cocoa_kit~aliexpress-everything/run-sync": { "post": { "operationId": "run-sync-cocoa_kit-aliexpress-everything", "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": { "searchQuery": { "title": "Search query", "type": "string", "description": "Find products with this search text." }, "startUrls": { "title": "Search, category, or product URLs", "type": "array", "description": "Start from HTTPS AliExpress search, category, or product URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Maximum products", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of unique product or listing rows. Reviews have a separate limit.", "default": 50 }, "detailedItems": { "title": "Get product details", "type": "boolean", "description": "Open each product page for specifications, variants, images, and seller data.", "default": false }, "includeReviews": { "title": "Get reviews", "type": "boolean", "description": "Collect public review text, country, date, purchased variant, and images. Names and profile data are excluded.", "default": false }, "maxReviews": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of review rows for each product.", "default": 20 }, "site": { "title": "AliExpress site", "enum": [ "aliexpress.com", "aliexpress.us", "de.aliexpress.com", "fr.aliexpress.com", "es.aliexpress.com", "it.aliexpress.com", "pt.aliexpress.com", "ru.aliexpress.com", "ja.aliexpress.com" ], "type": "string", "description": "Select the site and page language.", "default": "aliexpress.com" }, "shipCountry": { "title": "Ship-to country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code. The Actor sends this market to AliExpress.", "default": "US" }, "currency": { "title": "Currency override", "pattern": "^$|^[A-Za-z]{3}$", "type": "string", "description": "Optional three-letter currency code. If blank, use the normal currency for the ship-to country, or USD if no mapping is available.", "default": "" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use the existing automatic Apify proxy selection, or supply your own settings. Proxy usage can have a cost.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Concurrent requests", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum requests at the same time. Product requests can start a browser.", "default": 1 }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retries after the first request fails.", "default": 2 }, "requestDelaySecs": { "title": "Request delay", "minimum": 0, "maximum": 60, "type": "integer", "description": "Delay in seconds before each HTTP request.", "default": 1 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Timeout in seconds for one network request or browser navigation.", "default": 60 }, "maxPages": { "title": "Maximum listing pages per URL", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop each search or category at this page limit.", "default": 100 } } }, "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 } } } } } } } } } }