{ "openapi": "3.0.1", "info": { "title": "Alibaba Product Scraper", "description": "Scrape Alibaba product data: title, price, supplier, images, rating, and description. Provide product URLs, a search-results URL, or a search keyword. Export to JSON, CSV, or Excel, run via API, schedule runs, or integrate with other tools.", "version": "0.0", "x-build-id": "fd8mcAhPbKZYdTT8Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/e-commerce~alibaba-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-e-commerce-alibaba-product-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/e-commerce~alibaba-product-scraper/runs": { "post": { "operationId": "runs-sync-e-commerce-alibaba-product-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/e-commerce~alibaba-product-scraper/run-sync": { "post": { "operationId": "run-sync-e-commerce-alibaba-product-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": { "detailsUrls": { "title": "Product detail URLs", "type": "array", "description": "Direct URLs to individual Alibaba product pages. The Alibaba Product Scraper fetches each URL and returns that product's full data: title, price, supplier, images, rating, and description. Example: https://www.alibaba.com/product-detail/Wholesale-750ml-Stainless-Steel-Bottle_1600569797644.html. Accepts Alibaba product (/product-detail/) URLs, with or without https://; put search-results URLs in the field below instead. Use this when you already know exactly which products you want, as it is the fastest and most reliable input.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingUrls": { "title": "Search-results / listing URLs", "type": "array", "description": "URLs to Alibaba search-results or listing pages that contain many products. The scraper opens each listing, collects the product URLs it finds (following pagination), then scrapes each product's details. Example: https://www.alibaba.com/trade/search?SearchText=water+bottle. Accepts Alibaba search-results and showroom URLs. Use this to scrape a whole search or category without listing every product URL yourself; pair it with 'Total maximum products' to cap the run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keyword": { "title": "Search keyword", "type": "string", "description": "A search term used to find Alibaba products. The scraper runs the search on Alibaba.com, collects the matching product URLs, then scrapes each product's details. Example: stainless steel water bottle. Enter a single search phrase. Use 'Total maximum products' to limit how many results are scraped, since broad B2B searches can return thousands of matches." }, "additionalProperties": { "title": "Include additional properties", "type": "boolean", "description": "Whether to include extra, source-specific product attributes in the output. When enabled, the scraper asks Alibaba for additional details (such as minimum order quantity, attributes, and supplier metadata) and adds them under 'additionalProperties'. Example: enable this to capture minimum order quantity for sourcing research. This adds more data per product at a small extra time cost. Recommended: on for supplier and sourcing analysis, off for the fastest price-and-title-only runs.", "default": false }, "maxProductResults": { "title": "Total maximum products", "minimum": 1, "type": "integer", "description": "The maximum total number of products to scrape in one run, across all URLs and keywords combined. The scraper stops once this many products have been saved, so search and listing inputs never run away. Example: 100. Accepts any positive whole number. Lower values cost less and finish faster; leave empty to scrape everything found. Recommended: start with 50 to 100 to preview results before a full run." } } }, "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 } } } } } } } } } }