{ "openapi": "3.0.1", "info": { "title": "Alibaba Listings Scraper", "description": "The Alibaba Listings Scraper extracts paginated public product results from Alibaba for market research and supplier analysis.", "version": "1.1", "x-build-id": "qtlybQB34tOiU7hHh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~alibaba-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-alibaba-listings-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/w3crawler~alibaba-listings-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-alibaba-listings-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/w3crawler~alibaba-listings-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-alibaba-listings-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": { "searchQuery": { "title": "Search query", "maxLength": 200, "type": "string", "description": "Product keywords used to build a public Alibaba search URL when no source URLs are supplied.", "default": "wireless earbuds" }, "queries": { "title": "Additional queries", "maxItems": 25, "type": "array", "description": "Additional product queries. Each query becomes an independent public source and can be paginated.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "sourceUrls": { "title": "Alibaba search URLs", "maxItems": 50, "type": "array", "description": "One or more public Alibaba search, category, or showroom URLs. When supplied, these take precedence over generated queries.", "items": { "type": "string", "minLength": 1 }, "default": [ "https://www.alibaba.com/trade/search?SearchText=wireless%20earbuds" ] }, "startUrls": { "title": "Start URLs (alias)", "maxItems": 50, "type": "array", "description": "Compatibility alias for sourceUrls.", "items": { "type": "string", "minLength": 1 } }, "maxPages": { "title": "Maximum pages per source", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of linked public result pages to request for each source. The Actor follows Alibaba's observed next-page links and uses a safe URL fallback when needed.", "default": 2 }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum product rows emitted after global filtering, deduplication, and sorting.", "default": 100 }, "sortBy": { "title": "Sort results", "enum": [ "relevance", "price_asc", "price_desc", "supplier_rating_desc", "review_count_desc", "sold_count_desc", "supplier_years_desc", "moq_asc", "title_asc" ], "type": "string", "description": "Stable result ordering applied after all source pages are collected.", "default": "relevance" }, "textQuery": { "title": "Text filter", "maxLength": 200, "type": "string", "description": "Keep rows whose observed title, supplier, category, badge, or selling-point text contains this value." }, "currency": { "title": "Currency filter", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Keep only rows with this observed three-letter currency code, such as USD, INR, EUR, or CNY." }, "supplierCountries": { "title": "Supplier countries", "maxItems": 100, "type": "array", "description": "Keep rows whose observed supplier country/region code matches one of these values, for example CN or IN.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep a price range when its advertised upper bound reaches this value." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep a price range when its advertised lower bound is at or below this value." }, "minOrderQuantity": { "title": "Minimum MOQ", "minimum": 0, "type": "number", "description": "Keep listings with an observed minimum order quantity at or above this value." }, "maxOrderQuantity": { "title": "Maximum MOQ", "minimum": 0, "type": "number", "description": "Keep listings with an observed minimum order quantity at or below this value." }, "minSupplierRating": { "title": "Minimum supplier rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep listings with a displayed supplier/product rating at or above this five-point value." }, "minReviewCount": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Keep listings with at least this displayed review count." }, "minSoldCount": { "title": "Minimum sold count", "minimum": 0, "type": "integer", "description": "Keep listings with at least this publicly displayed sold count." }, "minSupplierYears": { "title": "Minimum supplier tenure", "minimum": 0, "maximum": 100, "type": "number", "description": "Keep listings from suppliers with at least this observed number of years on Alibaba." }, "minReorderRatePercent": { "title": "Minimum reorder rate (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Keep listings with a displayed reorder rate at or above this percentage." }, "requiredBadges": { "title": "Required badges", "maxItems": 20, "type": "array", "description": "Keep rows whose observed badge labels contain every listed value, for example certified or 5% off.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "requiredCertifications": { "title": "Required certifications", "maxItems": 20, "type": "array", "description": "Keep rows whose observed badge, selling-point, or attribute text contains every listed certification.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "certifiedOnly": { "title": "Certified products only", "type": "boolean", "description": "Keep only cards with explicit certified, verified, assessed, or Gold Supplier evidence.", "default": false }, "deduplicate": { "title": "Deduplicate products", "type": "boolean", "description": "Suppress the same canonical product URL across pages and sources.", "default": true }, "includeMedia": { "title": "Include product media", "type": "boolean", "description": "Include only product-scoped public Alibaba CDN imageUrl, thumbnailUrl, imageUrls, imageAlt, and imageCount fields.", "default": true }, "includeAttributes": { "title": "Include attributes", "type": "boolean", "description": "Include observed product specification key-value attributes when the public card exposes them.", "default": true }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay before each live public request. Use a respectful value and follow Alibaba's terms and robots policy.", "default": 1000 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of independent source crawls running concurrently. Pagination within each source stays ordered.", "default": 2 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries for transient network failures. Access challenges and unsafe redirects are fail-closed and are not bypassed.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 15, "maximum": 300, "type": "integer", "description": "Timeout for one public page request.", "default": 60 }, "maxResponseBytes": { "title": "Maximum response size", "minimum": 100000, "maximum": 50000000, "type": "integer", "description": "Safety cap for a downloaded HTML response.", "default": 20000000 }, "proxyConfiguration": { "title": "Apify Proxy", "type": "object", "description": "Optional standard Apify Proxy routing for public requests. Proxying changes the route only; it does not solve CAPTCHA or bypass access controls.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route public requests through Apify Proxy." }, "apifyProxyGroups": { "title": "Proxy groups", "type": "array", "description": "Optional Apify Proxy groups.", "items": { "type": "string" } }, "apifyProxyCountry": { "title": "Proxy country", "type": "string", "description": "Optional two- or three-letter Apify Proxy country code.", "pattern": "^[A-Za-z]{2,3}$" } }, "additionalProperties": false }, "userAgent": { "title": "User-Agent override", "maxLength": 300, "type": "string", "description": "Optional transparent browser-like User-Agent for public requests." }, "locale": { "title": "Request locale", "maxLength": 20, "type": "string", "description": "Locale sent in Accept-Language, such as en-US or en-GB.", "default": "en-US" } } }, "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 } } } } } } } } } }