{
"openapi": "3.0.1",
"info": {
"title": "1688.com Search Scraper",
"description": "Searches 1688.com by keyword and returns product listings: title, price, image, seller, sales and location.",
"version": "0.0",
"x-build-id": "9Mfn5LKODDVDMnObb"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/datacach~1688-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-datacach-1688-search-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/datacach~1688-search-scraper/runs": {
"post": {
"operationId": "runs-sync-datacach-1688-search-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/datacach~1688-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-datacach-1688-search-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",
"required": [
"keywords"
],
"properties": {
"keywords": {
"title": "Search keywords",
"type": "array",
"description": "The search terms to look up on 1688.com. Each keyword runs as its own search, so you can scrape several at once. For example: michael jackson, bluetooth speaker. Keywords may be in English or Chinese. Free plan is capped at 1 keyword per run.",
"items": {
"type": "string"
}
},
"maxItemsPerKeyword": {
"title": "Max products per keyword",
"minimum": 1,
"maximum": 2000,
"type": "integer",
"description": "The maximum number of products to scrape for each keyword. Results are fetched in pages of 60, so higher values mean more requests and longer, more expensive runs. Scraping stops early when the last result page or 1688's ~2000-result cap is reached. Free plan is capped at 10 products per keyword.",
"default": 60
},
"searchType": {
"title": "Marketplace",
"enum": [
"pcmarket",
"pcindustry"
],
"type": "string",
"description": "Which 1688 marketplace to search. Choose Consumer market for general/retail wholesale products, or Industrial market for industrial and B2B supplies.",
"default": "pcmarket"
},
"minPrice": {
"title": "Min price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Only return products with a unit price at or above this value, in Chinese Yuan (CNY). Leave empty for no lower bound."
},
"maxPrice": {
"title": "Max price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Only return products with a unit price at or below this value, in Chinese Yuan (CNY). Combine with Min price to target a price range — useful for splitting a broad search and getting past the ~2000-result cap. Leave empty for no upper bound."
},
"minOrderQuantity": {
"title": "Minimum order quantity",
"minimum": 1,
"type": "integer",
"description": "Only return products whose minimum order quantity (MOQ) is at or below this number of units. Leave empty to ignore MOQ."
},
"sortBy": {
"title": "Sort results by",
"enum": [
"relevance",
"sales",
"price"
],
"type": "string",
"description": "How to order the results. Relevance is 1688's default ranking, Sales volume surfaces best-sellers first, and Price orders by unit price.",
"default": "relevance"
},
"sortDescending": {
"title": "Sort descending",
"type": "boolean",
"description": "When sorting by Sales volume or Price, turn this on for highest-first (descending) order, or off for lowest-first (ascending). Ignored when sorting by Relevance.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Select proxies to avoid rate limiting and blocks from 1688.com. Apify Proxy with datacenter servers is recommended and enabled by default.",
"default": {
"useApifyProxy": true
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}