{
"openapi": "3.0.1",
"info": {
"title": "1688 Product Scraper",
"description": "Scrape 1688.com wholesale products by keyword, product URL or offer ID. Get the full MOQ price ladder, minimum order, supplier company and badges, sales counts, ships-from province/city, images, attributes and SKU variants as clean JSON/CSV. No 1688 login needed. Pay only for results.",
"version": "1.0",
"x-build-id": "ERsg1nwlpIYxBj91w"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/axlymxp~1688-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-axlymxp-1688-product-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/axlymxp~1688-product-scraper/runs": {
"post": {
"operationId": "runs-sync-axlymxp-1688-product-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/axlymxp~1688-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-axlymxp-1688-product-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": "Search keywords",
"type": "array",
"description": "Products to search on 1688.com, one keyword per line. Chinese keywords return the most results (e.g. 手机壳, 保温杯); English works for common product names. Each keyword yields up to 2,000 offers (1688's own cap), 20 per page.",
"items": {
"type": "string"
}
},
"productUrls": {
"title": "Product URLs",
"type": "array",
"description": "1688 offer pages to scrape in full (SKUs, attributes, images, rating, shipping). Accepts https://detail.1688.com/offer/735353578254.html and m.1688.com/offer/... links.",
"items": {
"type": "string"
}
},
"offerIds": {
"title": "Offer IDs",
"type": "array",
"description": "Numeric offer IDs (the number in the product URL). Same output as Product URLs.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Max products",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Stop after this many products in total. You are charged per product saved.",
"default": 100
},
"sortBy": {
"title": "Sort search results",
"enum": [
"default",
"sales",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Order 1688 ranks keyword results in. 'Best match' is 1688's default ranking.",
"default": "default"
},
"enrichSearchResults": {
"title": "Fetch full detail for search results",
"type": "boolean",
"description": "Also open every search hit's product page to add SKU variants with stock, all attributes, all images, rating, review count, shipping promise and category name. Slower (one extra page per product, ~100 KB of proxy traffic each).",
"default": false
},
"priceMin": {
"title": "Min unit price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Keep only products whose lowest tier price is at least this many yuan."
},
"priceMax": {
"title": "Max unit price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Keep only products whose lowest tier price is at most this many yuan."
},
"maxMoq": {
"title": "Max minimum order quantity",
"minimum": 1,
"type": "integer",
"description": "Keep only products whose MOQ is at most this number of units (e.g. 10 to find suppliers who sell small lots)."
},
"includeAds": {
"title": "Include promoted listings",
"type": "boolean",
"description": "Keyword results include 1688's promoted (P4P) listings, flagged with isAd: true. Turn off to keep organic results only.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Residential proxies are required for real runs. 1688 allows only a handful of requests per IP before it shows a slider captcha; Apify RESIDENTIAL proxies rotate the exit IP on every request, which is exactly what this Actor needs. Datacenter IPs are blocked quickly.",
"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
}
}
}
}
}
}
}
}
}
}