{ "openapi": "3.0.1", "info": { "title": "1688.com Search Scraper", "description": "Search and scrapes product data (prices, sellers, sales) from 1688.com with keyword search, pagination, and proxy support. Built for bulk B2B data extraction using Apify.", "version": "0.1", "x-build-id": "R5bmwKNfIxY6KWMgb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/songd~1688-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-songd-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/songd~1688-search-scraper/runs": { "post": { "operationId": "runs-sync-songd-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/songd~1688-search-scraper/run-sync": { "post": { "operationId": "run-sync-songd-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": [ "maxPages" ], "properties": { "keyword": { "title": "Search Keyword", "type": "string", "description": "Product search term (e.g., 'LED lights'). Required when not using searchArray." }, "maxPages": { "title": "Max Pages per Search", "minimum": 1, "type": "integer", "description": "Maximum pages to scrape per search (1 page ≈ 100 products). Also acts as maxRequestsPerCrawl." }, "priceStart": { "title": "Minimum Price (CNY)", "pattern": "^\\d+(\\.\\d+)?$", "type": "string", "description": "Filter products by minimum price in CNY. Use decimal values for cents (e.g., '50' or '29.99')" }, "priceEnd": { "title": "Maximum Price (CNY)", "pattern": "^\\d+(\\.\\d+)?$", "type": "string", "description": "Filter products by maximum price in CNY. Use decimal values for cents (e.g., '200' or '149.95')" }, "sortType": { "title": "Sort By", "enum": [ "normal", "va_sales360", "price" ], "type": "string", "description": "Results sorting method: 'normal' (default), 'va_sales360' (sales volume), or 'price'" }, "descendOrder": { "title": "Descending Sort Order", "type": "boolean", "description": "Enable for descending sort (highest first) based on chosen sort type" }, "quantityBegin": { "title": "Minimum Order Quantity", "type": "integer", "description": "Filter products requiring minimum order quantity (e.g., 100 units)" }, "searchArray": { "title": "Multiple Search Configurations", "uniqueItems": true, "type": "array", "description": "Perform multiple searches in one run (overrides individual parameters). Each entry requires 'keyword', 'maxPages' is not required." }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings to prevent IP blocking. Recommended for large-scale scraping." }, "searchType": { "title": "Market Type", "enum": [ "pcmarket", "pcindustry" ], "type": "string", "description": "Select between general consumer market or industrial wholesale market" } } }, "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 } } } } } } } } } }