{ "openapi": "3.0.1", "info": { "title": "1688 Scraper - Wholesale Prices, MOQ & Suppliers", "description": "1688.com scraper for China wholesale offers. Search by keyword or offer ID and export CNY price ladders, MOQ, sold counts, factory flags, images, and supplier location. 1688 API alternative for Python, Node.js, and MCP.", "version": "0.1", "x-build-id": "QbjKBFai8gBcqqEhF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~1688-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-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/crawloop~1688-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-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/crawloop~1688-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Wholesale keywords. Chinese terms return denser catalogs (e.g. 手机壳); English works but is thinner. Each keyword is searched separately.", "items": { "type": "string" } }, "offerUrls": { "title": "Offer URLs", "type": "array", "description": "Public 1688 product URLs. Example in JSON: https://detail.1688.com/offer/588600851175.html", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "offerIds": { "title": "Offer IDs", "type": "array", "description": "Numeric 1688 offer IDs when you already know the products. Skips keyword search for those IDs.", "items": { "type": "string" } }, "supplierUrls": { "title": "Supplier / shop URLs", "type": "array", "description": "Best-effort shop catalog. 1688 often challenges public shop pages; failed shops are skipped and not billed.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sortBy": { "title": "Sort", "enum": [ "relevance", "bestSelling", "priceAsc", "priceDesc" ], "type": "string", "description": "Keyword ranking. Best selling uses 30-day transaction count on the search card.", "default": "relevance" }, "priceMin": { "title": "Minimum price (CNY)", "minimum": 0, "type": "integer", "description": "Keep offers whose lowest unit price is at least this many yuan." }, "priceMax": { "title": "Maximum price (CNY)", "minimum": 0, "type": "integer", "description": "Keep offers whose lowest unit price is at most this many yuan." }, "minOrderQuantity": { "title": "Maximum acceptable MOQ", "minimum": 1, "type": "integer", "description": "Keep suppliers whose minimum order is at most this quantity. Offers with no MOQ are dropped when this filter is set." }, "merchantType": { "title": "Supplier type", "enum": [ "any", "superFactory", "verifiedMerchant" ], "type": "string", "description": "Filter by factory / super-factory signals published on the card or offer page.", "default": "any" }, "province": { "title": "Province", "type": "string", "description": "Chinese province name, e.g. 广东 or 浙江. Pinyin is ignored by 1688 search." }, "city": { "title": "City", "type": "string", "description": "Optional city substring filter on returned rows (e.g. 深圳, 义乌)." }, "includeDetails": { "title": "Fetch offer details", "type": "boolean", "description": "Open each offer page for the MOQ price ladder, gallery, sold text, factory card type, and review summary. Slower, richer rows.", "default": false }, "includeSkuDetails": { "title": "Include SKU variants", "type": "boolean", "description": "Add skuVariants (spec, price, stock). Implies offer details. Larger output.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum dataset rows across all keywords and IDs.", "default": 50 }, "maxPagesPerKeyword": { "title": "Max search pages per keyword", "minimum": 1, "maximum": 40, "type": "integer", "description": "About 20 offers per page. 1688 search depth is capped per keyword.", "default": 3 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Politeness delay between search pages and offer fetches.", "default": 400 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "China or Hong Kong residential is recommended. Datacenter IPs work for a few mtop calls, then 1688 serves a challenge page." } } }, "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 } } } } } } } } } }