{ "openapi": "3.0.1", "info": { "title": "Alibaba.com Rental Scraper", "description": "Bounded public Alibaba.com rental-search and product-detail extraction with price, supplier, and product metadata. Search pages are subject to Alibaba robots/access policy and are never bypassed.", "version": "1.2", "x-build-id": "0LWDzBncc2d1knp1p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~alibaba-com-rental-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-alibaba-com-rental-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-com-rental-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-alibaba-com-rental-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-com-rental-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-alibaba-com-rental-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": { "keyword": { "title": "Search keyword", "minLength": 1, "maxLength": 200, "type": "string", "description": "Keyword used to build the default public Alibaba search URL when startUrls is empty.", "default": "rental" }, "textQuery": { "title": "Text filter", "maxLength": 200, "type": "string", "description": "Optional case-insensitive text match across observed title, description, category, location, and supplier name." }, "category": { "title": "Category filter", "maxLength": 200, "type": "string", "description": "Optional case-insensitive match against the observed product category." }, "startUrls": { "title": "Public Alibaba start URLs", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "One or more public HTTPS Alibaba search, catalog, category, countrysearch, wholesale, showroom, or product-detail URLs. Pages are paginated per source and share one global maxItems limit.", "items": { "type": "string" } }, "productUrls": { "title": "Specific product URLs", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional public Alibaba product-detail URLs to request directly. These are processed as bounded detail targets after source pages.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global maximum number of product rows emitted across all sources and pages after filtering and sorting.", "default": 25 }, "maxPages": { "title": "Maximum pages per source", "minimum": 0, "maximum": 100, "type": "integer", "description": "Pages followed for each start URL. Use 0 for automatic pagination up to the Actor's hard 100-page safety cap.", "default": 1 }, "sortBy": { "title": "Sort results", "enum": [ "relevance", "price_asc", "price_desc", "rating_desc", "reviews_desc", "sold_desc", "supplier_years_desc", "moq_asc", "title_asc" ], "type": "string", "description": "Sort after all permitted sources are extracted and filters are applied. Relevance preserves source/page/card order.", "default": "relevance" }, "deduplicate": { "title": "Deduplicate listings", "type": "boolean", "description": "Merge repeated product IDs or canonical product URLs across pages and sources.", "default": true }, "includeImages": { "title": "Include product images", "type": "boolean", "description": "Include only product-scoped public Alibaba CDN image URLs, with thumbnail equal to the first image.", "default": true }, "includeAttributes": { "title": "Include product attributes", "type": "boolean", "description": "Keep published JSON-LD additional properties and common product attributes when available.", "default": true }, "includeDiagnostics": { "title": "Include diagnostics in dataset", "type": "boolean", "description": "When enabled, blocked, unavailable, empty, or invalid source events are written as minimal {url, error, errorCode} rows. Operational counts remain in OUTPUT_SUMMARY.", "default": true }, "rentalOnly": { "title": "Require rental signal", "type": "boolean", "description": "Emit only products with a configured rental keyword plus independent published rental-service evidence such as a rental period, rate, availability, or booking term.", "default": true }, "rentalKeywords": { "title": "Rental signal keywords", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Case-insensitive words or phrases used with source-backed rental-service evidence to calculate rentalMatch and enforce rentalOnly.", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "default": [ "rental", "rent", "hire", "leasing", "lease", "出租", "租赁" ] }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep records with an observed price at or above this value. Missing prices do not pass an active price filter." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep records with an observed price at or below this value. Missing prices do not pass an active price filter." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep records with an observed rating at or above this value." }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "type": "number", "description": "Keep records with an observed review count at or above this value." }, "minSoldCount": { "title": "Minimum sold count", "minimum": 0, "type": "number", "description": "Keep records with an observed sold or transaction count at or above this value." }, "minSupplierYears": { "title": "Minimum supplier years", "minimum": 0, "maximum": 200, "type": "number", "description": "Keep records with an observed supplier tenure at or above this value." }, "minOrderQuantity": { "title": "Minimum order quantity", "minimum": 0, "type": "number", "description": "Keep records whose observed MOQ is at or above this value." }, "maxOrderQuantity": { "title": "Maximum order quantity", "minimum": 0, "type": "number", "description": "Keep records whose observed MOQ is at or below this value." }, "supplierCountry": { "title": "Supplier country", "pattern": "^[A-Za-z]{2}$", "maxLength": 2, "type": "string", "description": "Optional exact two-letter supplier country code, such as CN or US." }, "requiredBadges": { "title": "Required badges", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Keep records whose observed badge list contains every requested value, case-insensitively.", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "default": [] }, "enrichDetails": { "title": "Enrich product details", "type": "boolean", "description": "Follow a bounded number of public product-detail URLs found on permitted source pages.", "default": false }, "maxDetailPages": { "title": "Maximum detail pages", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum discovered product-detail pages requested when enrichment is enabled.", "default": 5 }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum delay between starts of public requests. Use respectful pacing for live sources.", "default": 1000 }, "maxConcurrency": { "title": "Source concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of start URLs or detail URLs processed concurrently. Pagination within one source remains sequential.", "default": 1 }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for transient network, timeout, 408, 425, 429, and 5xx failures. Challenge responses fail closed.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum time allowed for one public response.", "default": 30 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 100000, "maximum": 30000000, "type": "integer", "description": "Safety cap for one HTML response.", "default": 20000000 }, "proxyConfiguration": { "title": "Apify Proxy", "type": "object", "description": "Optional standard Apify Proxy route for permitted public requests. Proxying never bypasses robots, login, CAPTCHA, or access controls.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "description": "Route permitted public requests through standard Apify Proxy.", "type": "boolean" }, "apifyProxyGroups": { "title": "Proxy groups", "description": "Optional standard Apify Proxy groups.", "type": "array", "items": { "type": "string" } }, "apifyProxyCountry": { "title": "Proxy country", "description": "Optional two-letter standard Apify Proxy country code.", "type": "string", "pattern": "^[A-Za-z]{2}$" } }, "additionalProperties": false }, "fixtureFile": { "title": "Single HTML fixture", "pattern": "^(?!.*(?:^|[/\\\\])\\.\\.(?:[/\\\\]|$))(?![/\\\\])[^:]+\\.(?:html?|xhtml)$", "type": "string", "description": "Optional Actor-relative HTML fixture for deterministic local validation. No network requests are made in fixture mode." }, "fixtureFiles": { "title": "Paginated HTML fixtures", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Optional ordered Actor-relative HTML fixtures; array index 0 is page 1, index 1 is page 2, and so on. Mutually exclusive with fixtureFile.", "items": { "type": "string", "pattern": "^(?!.*(?:^|[/\\\\])\\.\\.(?:[/\\\\]|$))(?![/\\\\])[^:]+\\.(?:html?|xhtml)$" }, "default": [] }, "timeoutMs": { "title": "Legacy timeout (ms)", "minimum": 10000, "maximum": 180000, "type": "integer", "description": "Backward-compatible alias for requestTimeoutSecs. Prefer requestTimeoutSecs in new inputs." } } }, "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 } } } } } } } } } }