{ "openapi": "3.0.1", "info": { "title": "1688.com Scraper & Price Monitor", "description": "Scrape 1688.com wholesale products by keyword (Chinese or English) or product URL: tiered wholesale prices, MOQ, SKUs with stock, sales and supplier details. Monitor mode flags new listings, price drops and stock-outs since the last run, with webhook alerts. Pay per product.", "version": "0.1", "x-build-id": "TM6EnNSZyMMmMOncj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yushi3~1688-product-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yushi3-1688-product-monitor", "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/yushi3~1688-product-monitor/runs": { "post": { "operationId": "runs-sync-yushi3-1688-product-monitor", "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/yushi3~1688-product-monitor/run-sync": { "post": { "operationId": "run-sync-yushi3-1688-product-monitor", "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 for on 1688, in Chinese (保温杯) or English (phone case), or 1688 search URLs. Chinese keywords give the most relevant results.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "1688 product pages (https://detail.1688.com/offer/1078135980629.html, mobile links work too) or bare offer IDs. Each returns the full product: price tiers, every SKU with its stock, sales and supplier.", "items": { "type": "string" } }, "maxProductsPerKeyword": { "title": "Max products per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many search results for each keyword (20 per results page, up to 1,000).", "default": 40 }, "scrapeDetails": { "title": "Open each search result's product page", "type": "boolean", "description": "Search results already include price tiers, MOQ, sales and supplier. Turn on to also open every result's product page for SKUs, stock per SKU, total stock and rating (charged as a product detail).", "default": false }, "onlyChanges": { "title": "Only changes", "type": "boolean", "description": "Return (and charge for) only products that are new in a keyword's results, or whose price or stock changed, since the previous run for the same keyword or product. The first run returns everything and becomes the baseline. Turn on for scheduled price monitoring.", "default": false }, "translateToEnglish": { "title": "English titles and USD prices", "type": "boolean", "description": "Adds titleEn (the title in English), attributesEn for every SKU, and priceUsd at today's ECB exchange rate. Translations are made by an AI model (Claude) instructed to write listing-style English and keep sizes, units and model names, and are remembered so repeat runs re-use them. Charged as a small add-on per product.", "default": false }, "alertWebhookUrl": { "title": "Alert webhook URL", "type": "string", "description": "Optional. Receives a POST for each new listing, price drop, price increase, stock-out or restock since the previous run." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. By default 1688 is tried directly and escalates to Apify datacenter, then residential proxies (with fresh sessions on CAPTCHA pages); the proxy that works is remembered for a week. Set a proxy here to use it for every request instead." } } }, "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 } } } } } } } } } }