{ "openapi": "3.0.1", "info": { "title": "Alibaba Supplier Scraper", "description": "Extract detailed Supplier profiles from Alibaba.com for vendor sourcing and supply chain research. Get Gold Supplier tenure,factory size, staff count, annual revenue, response rates, product portfolios, ratings and verification status.", "version": "1.3", "x-build-id": "VPNpPfvBeDhB7cPp9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~alibaba-supplier-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-alibaba-supplier-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-supplier-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-alibaba-supplier-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-supplier-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-alibaba-supplier-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": { "searchKeywords": { "title": "Primary search keyword", "maxLength": 200, "type": "string", "description": "Compatibility input used when queries are not provided.", "default": "stainless steel" }, "queries": { "title": "Search queries", "maxItems": 25, "type": "array", "description": "Each query becomes an independently paginated public Alibaba search source.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [ "stainless steel" ] }, "keywords": { "title": "Keyword alias", "maxItems": 25, "type": "array", "description": "Compatibility alias for queries.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "searchQuery": { "title": "Single query alias", "maxLength": 200, "type": "string", "description": "Compatibility alias for one query." }, "query": { "title": "Single query alias", "maxLength": 200, "type": "string", "description": "Compatibility alias for one query." }, "keyword": { "title": "Single keyword alias", "maxLength": 200, "type": "string", "description": "Compatibility alias for one query." }, "searchKeyword": { "title": "Single keyword alias", "maxLength": 200, "type": "string", "description": "Compatibility alias for one query." }, "sourceUrls": { "title": "Public Alibaba source URLs", "maxItems": 50, "type": "array", "description": "Public Alibaba product-search, supplier-search, category, showroom, or profile URLs. These take precedence over generated queries.", "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "title": "Alibaba URL", "description": "Public Alibaba result, search, or supplier profile URL.", "type": "string", "minLength": 1 } } } }, "startUrls": { "title": "Start URLs alias", "maxItems": 50, "type": "array", "description": "Compatibility alias for sourceUrls.", "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "title": "Alibaba URL", "description": "Public Alibaba result, search, or supplier profile URL.", "type": "string", "minLength": 1 } } } }, "searchUrls": { "title": "Search URLs alias", "maxItems": 50, "type": "array", "description": "Compatibility alias for sourceUrls.", "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "title": "Alibaba URL", "description": "Public Alibaba result, search, or supplier profile URL.", "type": "string", "minLength": 1 } } } }, "urls": { "title": "URLs alias", "maxItems": 50, "type": "array", "description": "Compatibility alias for sourceUrls.", "items": { "type": "string", "minLength": 1 } }, "url": { "title": "Single source URL alias", "type": "string", "description": "One public Alibaba source URL." }, "searchUrl": { "title": "Single search URL alias", "type": "string", "description": "Compatibility alias for one public Alibaba search URL." }, "startPage": { "title": "Start page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "One-based page from which each source starts.", "default": 1 }, "start_page": { "title": "Start page alias", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Compatibility alias for startPage." }, "maxPages": { "title": "Maximum pages per source", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum ordered public result pages fetched for each source.", "default": 2 }, "max_pages": { "title": "Maximum pages alias", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compatibility alias for maxPages." }, "maxResults": { "title": "Maximum supplier records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum unique supplier rows emitted after filtering and sorting.", "default": 100 }, "maxProducts": { "title": "Maximum suppliers alias", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Compatibility alias for maxResults." }, "maxItems": { "title": "Maximum suppliers alias", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Compatibility alias for maxResults." }, "max_products": { "title": "Maximum suppliers alias", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Compatibility alias for maxResults." }, "max_items": { "title": "Maximum suppliers alias", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Compatibility alias for maxResults." }, "sortBy": { "title": "Sort suppliers", "enum": [ "relevance", "rating_desc", "reviews_desc", "supplier_years_desc", "supplier_name_asc", "title_asc" ], "type": "string", "description": "Stable ordering after all pages and sources are aggregated.", "default": "relevance" }, "textQuery": { "title": "Text filter", "maxLength": 200, "type": "string", "description": "Keep suppliers whose public name, country, company facts, badges, certifications, or product names contain this text." }, "supplierCountries": { "title": "Supplier countries", "maxItems": 100, "type": "array", "description": "Keep suppliers whose country/location contains one of these values.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "countries": { "title": "Supplier countries alias", "maxItems": 100, "type": "array", "description": "Compatibility alias for supplierCountries.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "currency": { "title": "Product currency", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Optional three-letter product currency filter." }, "minPrice": { "title": "Minimum product price", "minimum": 0, "type": "number", "description": "Keep suppliers with a public product price at or above this value." }, "price_min": { "title": "Minimum product price alias", "minimum": 0, "type": "number", "description": "Compatibility alias for minPrice." }, "maxPrice": { "title": "Maximum product price", "minimum": 0, "type": "number", "description": "Keep suppliers with a public product price at or below this value." }, "price_max": { "title": "Maximum product price alias", "minimum": 0, "type": "number", "description": "Compatibility alias for maxPrice." }, "minMoq": { "title": "Minimum MOQ", "minimum": 0, "type": "number", "description": "Keep suppliers with a public MOQ at or above this value." }, "moqMin": { "title": "Minimum MOQ alias", "minimum": 0, "type": "number", "description": "Compatibility alias for minMoq." }, "moq_min": { "title": "Minimum MOQ legacy alias", "minimum": 0, "type": "number", "description": "Compatibility alias for minMoq." }, "maxMoq": { "title": "Maximum MOQ", "minimum": 0, "type": "number", "description": "Keep suppliers with a public MOQ at or below this value." }, "moqMax": { "title": "Maximum MOQ alias", "minimum": 0, "type": "number", "description": "Compatibility alias for maxMoq." }, "moq_max": { "title": "Maximum MOQ legacy alias", "minimum": 0, "type": "number", "description": "Compatibility alias for maxMoq." }, "minRating": { "title": "Minimum supplier rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep suppliers at or above this public rating." }, "minSupplierRating": { "title": "Minimum rating alias", "minimum": 0, "maximum": 5, "type": "number", "description": "Compatibility alias for minRating." }, "minReviews": { "title": "Minimum review count", "minimum": 0, "type": "number", "description": "Keep suppliers with at least this many public reviews." }, "minReviewCount": { "title": "Minimum reviews alias", "minimum": 0, "type": "number", "description": "Compatibility alias for minReviews." }, "minProductRating": { "title": "Minimum product rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Minimum public product rating when exposed by a card." }, "minSoldCount": { "title": "Minimum sold count", "minimum": 0, "type": "number", "description": "Minimum public sold or order count." }, "minReorderRatePercent": { "title": "Minimum reorder rate", "minimum": 0, "maximum": 100, "type": "number", "description": "Minimum public reorder rate percentage." }, "minSupplierYears": { "title": "Minimum Alibaba years", "minimum": 0, "maximum": 200, "type": "number", "description": "Keep suppliers with at least this many observed Alibaba years." }, "verifiedOnly": { "title": "Verified suppliers only", "type": "boolean", "description": "Keep cards with public verified or assessed supplier evidence.", "default": false }, "requireVerified": { "title": "Verified suppliers alias", "type": "boolean", "description": "Compatibility alias for verifiedOnly." }, "requiredBadges": { "title": "Required supplier badges", "maxItems": 20, "type": "array", "description": "Keep suppliers containing every requested public badge.", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "requiredCertifications": { "title": "Required certifications", "maxItems": 20, "type": "array", "description": "Keep suppliers containing every requested certification.", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "tradeAssurance": { "title": "Trade Assurance only", "type": "boolean", "description": "Keep public Trade Assurance evidence." }, "trade_assurance": { "title": "Trade Assurance alias", "type": "boolean", "description": "Compatibility alias for tradeAssurance." }, "verifiedSupplier": { "title": "Verified supplier only", "type": "boolean", "description": "Keep public verified supplier evidence." }, "verified_supplier": { "title": "Verified supplier alias", "type": "boolean", "description": "Compatibility alias for verifiedSupplier." }, "alibabaGuaranteed": { "title": "Alibaba Guaranteed only", "type": "boolean", "description": "Keep public Alibaba Guaranteed evidence." }, "alibaba_guaranteed": { "title": "Alibaba Guaranteed alias", "type": "boolean", "description": "Compatibility alias for alibabaGuaranteed." }, "certifiedOnly": { "title": "Certified suppliers only", "type": "boolean", "description": "Keep public certification evidence." }, "deduplicate": { "title": "Deduplicate suppliers", "type": "boolean", "description": "Merge repeated supplier observations across pages and sources by supplier identity.", "default": true }, "includeDetails": { "title": "Fetch public profile details", "type": "boolean", "description": "Fetch public profile pages when a supplier profile URL is exposed.", "default": true }, "includeProfileDetails": { "title": "Profile details alias", "type": "boolean", "description": "Compatibility alias for includeDetails." }, "includeMedia": { "title": "Include public media", "type": "boolean", "description": "Keep supplier logos and product-scoped public Alibaba CDN images; flags and UI assets are excluded.", "default": true }, "includeAttributes": { "title": "Include product portfolio", "type": "boolean", "description": "Keep product links, names, price/MOQ signals, ratings, and sold/reorder signals.", "default": true }, "includeSupplierDetails": { "title": "Include company details", "type": "boolean", "description": "Keep public address, overview, employee, revenue, market, certification, and contact fields.", "default": true }, "renderJavaScript": { "title": "Render JavaScript", "type": "boolean", "description": "Use Chromium for current Alibaba result cards and pagination.", "default": true }, "useBrowser": { "title": "Render JavaScript alias", "type": "boolean", "description": "Compatibility alias for renderJavaScript." }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay before each public request.", "default": 1000 }, "pageDelayMs": { "title": "Request delay alias", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Compatibility alias for requestDelayMs." }, "maxConcurrency": { "title": "Maximum source concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum independent sources processed concurrently; pages within each source remain ordered.", "default": 2 }, "concurrency": { "title": "Concurrency alias", "minimum": 1, "maximum": 5, "type": "integer", "description": "Compatibility alias for maxConcurrency." }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries for transient public request failures.", "default": 3 }, "maxRetries": { "title": "Retries alias", "minimum": 0, "maximum": 10, "type": "integer", "description": "Compatibility alias for maxRequestRetries." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 15, "maximum": 300, "type": "integer", "description": "Maximum time for each public request.", "default": 30 }, "timeoutSecs": { "title": "Request timeout alias", "minimum": 15, "maximum": 300, "type": "integer", "description": "Compatibility alias for requestTimeoutSecs." }, "requestTimeoutMs": { "title": "Request timeout alias (ms)", "minimum": 15000, "maximum": 300000, "type": "integer", "description": "Compatibility alias converted to seconds." }, "timeoutMs": { "title": "Request timeout legacy alias (ms)", "minimum": 15000, "maximum": 300000, "type": "integer", "description": "Compatibility alias converted to seconds." }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 100000, "maximum": 50000000, "type": "integer", "description": "Reject unusually large public responses before parsing.", "default": 20000000 }, "maxBytes": { "title": "Maximum response bytes alias", "minimum": 100000, "maximum": 50000000, "type": "integer", "description": "Compatibility alias for maxResponseBytes." }, "browserWaitMs": { "title": "Browser settle time (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Time for client-rendered cards to settle after navigation.", "default": 1500 }, "renderWaitMs": { "title": "Browser settle time alias", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Compatibility alias for browserWaitMs." }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Optional transparent user-agent string." }, "locale": { "title": "Browser locale", "maxLength": 20, "type": "string", "description": "Browser locale for public page rendering.", "default": "en-US" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional ordinary Apify Proxy or public HTTP(S) routing. No stealth, CAPTCHA solving, or access-control bypass is attempted.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route public requests through Apify Proxy." }, "apifyProxyGroups": { "title": "Apify Proxy groups", "type": "array", "items": { "type": "string" }, "description": "Optional Apify Proxy groups." }, "apifyProxyCountry": { "title": "Apify Proxy country", "type": "string", "pattern": "^[A-Za-z]{2,3}$", "description": "Optional two- or three-letter country code." }, "proxyUrls": { "title": "Public proxy URLs", "type": "array", "items": { "type": "string" }, "description": "Optional public HTTP(S) proxy URLs." } }, "additionalProperties": false } } }, "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 } } } } } } } } } }