{ "openapi": "3.0.1", "info": { "title": "AliExpress Affiliate Products — Cross-Border Deals & Ratings", "description": "Discover trending AliExpress products by keyword. Extract real prices, sales volume, ratings, store data and commission rates from the public catalog. Pure HTTP, multi-language, multi-currency. Built for affiliate marketing pipelines.", "version": "3.0", "x-build-id": "GSEHlRJtgj6OdP6bw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~aliexpress-affiliate-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-aliexpress-affiliate-products", "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/viralanalyzer~aliexpress-affiliate-products/runs": { "post": { "operationId": "runs-sync-viralanalyzer-aliexpress-affiliate-products", "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/viralanalyzer~aliexpress-affiliate-products/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-aliexpress-affiliate-products", "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": [ "keywords" ], "properties": { "keywords": { "title": "Search Keywords", "minItems": 1, "maxItems": 20, "type": "array", "description": "Product search terms (e.g., 'wireless earbuds', 'smart watch', 'kitchen gadgets'). Each keyword runs a separate query and results are deduplicated by productId.", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Max Results per Keyword", "minimum": 1, "maximum": 60, "type": "integer", "description": "Maximum products to return per keyword (1-60). Each product passing validation triggers 1 PPE event.", "default": 30 }, "sortType": { "title": "Sort Order", "enum": [ "ORDERS_DESC", "SALE_PRICE_ASC", "SALE_PRICE_DESC", "NEWEST_DESC" ], "type": "string", "description": "Result ordering: SALE_PRICE_ASC, SALE_PRICE_DESC, NEWEST_DESC, ORDERS_DESC (most popular). Best for affiliate: ORDERS_DESC.", "default": "ORDERS_DESC" }, "minSales": { "title": "Minimum Orders", "minimum": 0, "type": "integer", "description": "Drop products with fewer historical orders. Use 0 for no filter.", "default": 50 }, "minRating": { "title": "Minimum Star Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop products with star rating below this (0-5). Use 0 for no filter.", "default": 4 }, "freeShippingOnly": { "title": "Only Free Shipping", "type": "boolean", "description": "Restrict to products with free shipping flag.", "default": false }, "language": { "title": "Language", "enum": [ "pt", "en", "es", "fr", "ru", "id" ], "type": "string", "description": "Storefront language. Affects product titles and descriptions.", "default": "pt" }, "currency": { "title": "Currency", "enum": [ "BRL", "USD", "EUR", "CNY", "GBP" ], "type": "string", "description": "Display currency for prices.", "default": "BRL" }, "shipToCountry": { "title": "Ship-to Country", "type": "string", "description": "ISO country code (BR, US, ES, etc) — filters products that ship there.", "default": "BR" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "AliExpress accepts global IPs — Apify Proxy datacenter is enough in most cases.", "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 } } }, "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 } } } } } } } } } }