{ "openapi": "3.0.1", "info": { "title": "1688 Global Product Search Scraper", "description": "Find verified English 1688 Global product listings with USD price evidence, supplier signals, images, sales text, and auditable search provenance. Detail pages are best-effort only.", "version": "0.2", "x-build-id": "N5GeS4Hl3123fd0hR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~1688-global-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-1688-global-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/lentic_clockss~1688-global-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-1688-global-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/lentic_clockss~1688-global-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-1688-global-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": { "mode": { "title": "Mode", "enum": [ "auto", "search", "ranking", "detail", "supplier" ], "type": "string", "description": "Auto selects detail for offerIds/startUrls, supplier for memberIds, otherwise search.", "default": "auto" }, "offerIds": { "title": "Offer IDs", "type": "array", "description": "Numeric IDs for detail mode. Chinese detail text and CNY prices remain labeled as such.", "items": { "type": "string" } }, "startUrls": { "title": "Detail URLs", "type": "array", "description": "HTTPS detail.1688.com/offer/.html URLs only.", "items": { "type": "string" } }, "memberIds": { "title": "Supplier member IDs", "type": "array", "description": "Verified supplier member IDs, including b2b- IDs and legacy alphanumeric IDs. Do not enter shop URLs.", "items": { "type": "string" } }, "rankingName": { "title": "Ranking", "enum": [ "Most_Popular", "New_Arrivals", "Trending", "Ranked_by_L30_Days_Total_Orders" ], "type": "string", "description": "Global ranking tab to collect.", "default": "Most_Popular" }, "categoryId": { "title": "Ranking category ID", "type": "string", "description": "Numeric 1688 category ID used by the ranking page.", "default": "54" }, "categoryLevel": { "title": "Category level", "minimum": 1, "maximum": 3, "type": "integer", "description": "Hierarchy level of the ranking category.", "default": 1 }, "countryCode": { "title": "Ranking country", "type": "string", "description": "Ranking filter, not proxy exit country.", "default": "CN" }, "includeLeads": { "title": "Enrich supplier contacts and company", "type": "boolean", "description": "Defaults to includeDetails. Contact/company modules are attempted without requiring a shop-page visit." }, "maxLeadItems": { "title": "Maximum supplier enrichment rows", "minimum": 0, "maximum": 100, "type": "integer", "description": "Defaults to maxDetailItems. Duplicate suppliers are fetched once per run." }, "includeDescription": { "title": "Include detail description and images", "type": "boolean", "description": "Retrieve product description text and images from its verified CDN link.", "default": true }, "includeContactInfo": { "title": "Attempt contact-information page", "type": "boolean", "description": "Optional best-effort landline/fax extraction from an observed supplier shop URL. Challenge or missing values remain explicit.", "default": false }, "keyword": { "title": "Search keyword (any language)", "type": "string", "description": "Product query in any language, for example phone case, 手机壳 or 무선 이어폰. Non-English text is translated to English before the search, because the 1688 Global surface only answers English queries; results stay English/USD.", "default": "phone case" }, "maxResults": { "title": "Max results per keyword or ID", "minimum": 1, "maximum": 100, "type": "integer", "description": "Most rows for each keyword, offer ID, or supplier member ID. Default 70; larger numbers are collected in parts of 70. All row types count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer).", "default": 70 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "International search pages to observe. Stops early when maxResults is reached.", "default": 1 }, "includeDetails": { "title": "Enrich detail + supplier leads (recommended)", "type": "boolean", "description": "Default on: parse product detail, SKU, attributes, images, shipping and ratings when available. CNY detail prices never overwrite USD search prices. Incomplete or blocked groups remain explicit.", "default": true }, "maxDetailItems": { "title": "Maximum detail attempts", "minimum": 0, "maximum": 20, "type": "integer", "description": "When includeDetails=true, number of emitted search rows to open (default 1). Capped by maxResults.", "default": 1 }, "proxyCountry": { "title": "Proxy country", "enum": [ "US" ], "type": "string", "description": "Only US is supported for this Actor's Global English/USD contract.", "default": "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 } } } } } } } } } }