{ "openapi": "3.0.1", "info": { "title": "1688 批发 Wholesale Scraper - Keyword & Photo Search, MOQ, Prices", "description": "Search 1688.com wholesale offers by keyword, or by photo: paste a product image and get similar products from 1688, Alibaba.com and AliExpress with price, MOQ, supplier and link. Export to CSV, Excel, JSON or XML.", "version": "0.3", "x-build-id": "Z33ziObSAJYxKK3e0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~1688-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~1688-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~1688-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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 per line, in Chinese or English (手机壳, wireless earbuds). Each term is searched separately and paged until Max Items is reached. 1688 serves at most 2,000 offers per query, so split broad keywords or add a category, city or price band to go deeper. Ignored when Image URLs are given.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "mode": { "title": "Mode", "enum": [ "auto", "keyword", "image" ], "type": "string", "description": "Auto uses photo search when Image URLs are filled in and keyword search otherwise. Pick a mode to force it.", "default": "auto" }, "imageUrls": { "title": "Image URLs", "type": "array", "description": "Public links to the product photos to search by, one per line. JPEG, PNG or WebP, up to 25 MB (larger photos are scaled down before upload). Each photo is searched on every platform you pick below. Max Matches per Photo caps each search and Max Items caps the whole run.", "items": { "type": "string" } }, "platforms": { "title": "Platforms", "type": "array", "description": "Where to look for similar products. 1688 gives CNY wholesale prices with MOQ; Alibaba.com gives USD export prices; AliExpress gives USD retail prices. Default: 1688 only.", "items": { "type": "string", "enum": [ "1688", "alibaba", "aliexpress" ], "enumTitles": [ "1688.com (wholesale, CNY)", "Alibaba.com (export, USD)", "AliExpress (retail, USD)" ] }, "default": [ "1688" ] }, "maxItemsPerImage": { "title": "Max Matches per Photo", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most similar products to return for each photo on each platform, closest matches first. Default 20, which costs about $0.07 per photo per platform (20 results at $0.0035; less on higher plans). Raise it for deeper lists: 1688 serves about 700 matches, Alibaba.com 100 and AliExpress about 600. Max Items still caps the run total. Keyword search ignores this.", "default": 20 }, "sortBy": { "title": "Sort By", "enum": [ "pop", "price_asc", "price_desc" ], "type": "string", "description": "Result order, as 1688's own sort menu.", "default": "pop" }, "minPrice": { "title": "Min Price (CNY)", "minimum": 0, "type": "integer", "description": "Only return offers priced at or above this amount, in Chinese yuan." }, "maxPrice": { "title": "Max Price (CNY)", "minimum": 0, "type": "integer", "description": "Only return offers priced at or below this amount, in Chinese yuan." }, "categoryId": { "title": "Category ID", "type": "string", "description": "1688 leaf category ID to restrict the search to, for example 1033246 (earphones). Every row returns its own categoryId, so run a keyword once, pick the category you want and run again with it." }, "city": { "title": "Supplier City", "type": "string", "description": "Only return suppliers located in this city, written as 1688 writes it, for example 深圳市 (Shenzhen), 广州市 (Guangzhou), 义乌市 (Yiwu), 东莞市 (Dongguan)." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify residential proxies are recommended. Datacenter IPs get about 5 calls before 1688 asks for a captcha.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }