{ "openapi": "3.0.1", "info": { "title": "1688.com Supplier Scraper", "description": "Find 1688 suppliers by keyword, search link, or exact company name. Get company links, location, service scores, factory details, and sample offers with CNY prices for supplier research.", "version": "1.0", "x-build-id": "5DjacFfrTzinPHNTS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~1688-com-supplier-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-1688-com-supplier-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/maximedupre~1688-com-supplier-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-1688-com-supplier-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/maximedupre~1688-com-supplier-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-1688-com-supplier-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": { "keywords": { "title": "Supplier search keywords", "type": "array", "description": "Enter English or Chinese product, factory, or manufacturer keywords. All keywords use the same criteria and supplier limit.", "items": { "type": "string", "minLength": 1 } }, "maxSuppliersPerQuery": { "title": "Maximum suppliers per search", "minimum": 0, "type": "integer", "description": "Collect up to this many supplier profiles for each keyword, search link, or company name. Leave empty or enter 0 to collect all suppliers that 1688 shows. On large searches, 1688 can stop showing results before the end, so the run can save fewer suppliers. A supplier is saved at most once per run." }, "marketplace": { "title": "Find suppliers in", "enum": [ "consumer", "industrial" ], "type": "string", "description": "Choose the 1688 marketplace that keyword and company name searches use. Search links keep the marketplace shown in the link.", "default": "consumer" }, "startUrls": { "title": "1688 search links", "type": "array", "description": "Enter full 1688 search links that include a search word, such as https://s.1688.com/selloffer/offer_search.htm?keywords=手机壳. Category links without a search word are not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companyNames": { "title": "Exact company names", "type": "array", "description": "Enter 1688 supplier company names exactly as 1688 shows them. Only suppliers with that exact name are returned.", "items": { "type": "string", "minLength": 1 } }, "marketplaceProgram": { "title": "Marketplace program", "enum": [ "any", "trustpass", "superFactory" ], "type": "string", "description": "Narrow suppliers by a membership or factory program shown on 1688. Choose Any program to skip this filter.", "default": "any" }, "supplierQualification": { "title": "Supplier role", "enum": [ "any", "factory" ], "type": "string", "description": "Choose Factory or manufacturer to keep only suppliers that 1688 shows with that role, or Any role to skip this filter.", "default": "any" }, "verificationStatus": { "title": "Verification or inspection", "enum": [ "any", "verified", "factoryInspected" ], "type": "string", "description": "Narrow suppliers by verification or factory inspection shown on 1688. These labels come from 1688. They are not an independent check.", "default": "any" }, "locations": { "title": "Supplier locations", "type": "array", "description": "Enter Chinese provinces, cities, or industrial regions to match, such as Guangdong or 深圳. Leave empty to search all locations.", "items": { "type": "string", "minLength": 1 } }, "minPriceCny": { "title": "Minimum offer price", "minimum": 0, "type": "number", "description": "Keep suppliers with a representative public offer at or above this CNY price when 1688 exposes price criteria." }, "maxPriceCny": { "title": "Maximum offer price", "minimum": 0, "type": "number", "description": "Keep suppliers with a representative public offer at or below this CNY price when 1688 exposes price criteria." }, "maxMinimumOrder": { "title": "Maximum minimum order", "minimum": 1, "type": "integer", "description": "Keep suppliers with a representative offer whose minimum order is at or below this quantity. The output keeps the sales unit 1688 shows." }, "minServiceScore": { "title": "Minimum service score", "minimum": 0, "type": "number", "description": "Keep only suppliers whose 1688 composite service score is at or above this value. 1688 shows this score on a scale of 0 to 5. Leave empty to skip this filter." }, "sortBy": { "title": "Order suppliers by", "enum": [ "relevance", "sales", "priceAsc", "priceDesc" ], "type": "string", "description": "Use 1688's relevance order, show top sellers first, or order by representative offer price. The order comes from 1688.", "default": "relevance" } } }, "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 } } } } } } } } } }