{ "openapi": "3.0.1", "info": { "title": "1688 Product Scraper", "description": "Scrape 1688.com products and search results without login, cookies or your own proxy. Get wholesale prices by quantity, variants with stock, sales, supplier card, ratings, dropshipping terms and description: about 100 fields per offer. Fast, pay per result, export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "tvy5bS6r0RoONvu9G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maksim_lazouski~1688-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maksim_lazouski-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/maksim_lazouski~1688-product-scraper/runs": { "post": { "operationId": "runs-sync-maksim_lazouski-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/maksim_lazouski~1688-product-scraper/run-sync": { "post": { "operationId": "run-sync-maksim_lazouski-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": { "offers": { "title": "Offer links or ids", "type": "array", "description": "1688 offers to read. Each line is a link such as https://detail.1688.com/offer/762640272016.html or just the number from it.", "items": { "type": "string" } }, "keywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search 1688 for. Chinese keywords find the most (手机壳 finds more than \"phone case\"). Every page of results holds 60 offers.", "items": { "type": "string" } }, "maxPagesPerKeyword": { "title": "Result pages per keyword", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many pages of search results to read for each keyword. 1688 shows a visitor who is not logged in three pages (up to 180 offers) per keyword, so 3 is the most. An offer that 1688 shows on more than one page is returned once.", "default": 1 }, "scrapeDetails": { "title": "Open every search result", "type": "boolean", "description": "Off: one short row per search result (title, price, sales, supplier, link). On: the actor opens the offer page of every result and returns the full offer row instead.", "default": false }, "includeExtras": { "title": "Supplier card, ratings, dropshipping terms and description", "type": "boolean", "description": "Adds to every offer the blocks its page loads beside the main data: the supplier card, the offer's ratings, the dropshipping terms and the description (text and pictures). Turn off to get only what the offer page itself carries.", "default": true }, "maxItems": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "The run stops once it has stored this many rows. Leave empty for no limit." }, "maxConcurrency": { "title": "Offers read side by side", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many offers and search pages are read at the same time, each from its own address. More is faster; the default suits most jobs.", "default": 10 } } }, "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 } } } } } } } } } }