{ "openapi": "3.0.1", "info": { "title": "1688 Scraper — Wholesale Products, Prices & Suppliers (China)", "description": "Scrape 1688.com wholesale offers by keyword, shop, offer URL or image search: CNY prices, MOQ, quantity price tiers, sales, SKUs, specs and supplier details. No login.", "version": "0.1", "x-build-id": "YjjQL6vy7I6OuggMU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~1688-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-1688-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/tortuga~1688-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-1688-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/tortuga~1688-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-1688-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search on 1688.com, one search per line. Chinese keywords give the best results (e.g. 蓝牙耳机, 手机壳). English keywords are not translated by 1688: they match offers whose titles contain the English word (common on cross-border listings), so Chinese keywords reach far more of the market. Titles are returned in Chinese as the sellers wrote them.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "1688 URLs: search result pages (s.1688.com/selloffer/offer_search.htm?keywords=..., filters in the URL are kept), shop listings (the shop's winport link with memberId=b2b-..., found in every result as supplier.winportUrl; .1688.com shop pages need a login and are not supported), offer pages (detail.1688.com/offer/.html, always scraped with full details) and image search pages (s.1688.com/youyuan/index.htm?imageAddress=...).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "imageUrls": { "title": "Image search: image URLs", "type": "array", "description": "Find suppliers by photo: one image URL per line (JPG/PNG/WEBP under 4 MB). Images on Alibaba's CDN (alicdn.com, e.g. an AliExpress or 1688 product photo) are searched directly; other images are uploaded to 1688's image search first. Returns up to 40 matching offers per page, with MOQ and quantity price tiers.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "default", "sales", "price_asc", "price_desc" ], "type": "string", "description": "Order of keyword and search-URL results. 'sales' = best sellers first (30-day volume).", "default": "default" }, "minPrice": { "title": "Min price (CNY)", "minimum": 0, "type": "number", "description": "Only offers priced at or above this many yuan (keyword and search-URL results)." }, "maxPrice": { "title": "Max price (CNY)", "minimum": 0, "type": "number", "description": "Only offers priced at or below this many yuan (keyword and search-URL results)." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many offers in total (all searches together). You pay per offer saved, so this caps the cost.", "default": 100 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 34, "type": "integer", "description": "Result pages to read per search term / URL: 60 offers per page for keyword and shop searches, 40 for image searches. 1688 shows at most 2,000 results per search (34 pages).", "default": 5 }, "includeDetails": { "title": "Include offer details", "type": "boolean", "description": "Open each offer page for MOQ, quantity price tiers, all SKU variants with price and stock, specifications, all images, description images, ship-from location, package weight and size, rating and supplier badges. Charged as an extra 'detail' event per offer and slower (one residential page load per offer).", "default": false }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "1688 answers search requests only from Chinese residential IPs (datacenter, US and HK IPs get a captcha), so the default is Apify RESIDENTIAL proxy with country CN. Proxy traffic is billed to your Apify account: about 50 KB per 60-offer search page and 30-120 KB per offer page with details.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" } } } }, "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 } } } } } } } } } }