{ "openapi": "3.0.1", "info": { "title": "1688 Global Scraper - Products, Rankings & Suppliers", "description": "Collect 1688 Global products, rankings, product details and supplier profiles. Keep USD search prices separate from CNY details, and pay per delivered row plus a start fee.", "version": "0.3", "x-build-id": "xIuPSmLuFo7AfSscF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~1688-global-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-1688-global-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/lentic_clockss~1688-global-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-1688-global-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/lentic_clockss~1688-global-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-1688-global-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": { "mode": { "title": "Mode", "enum": [ "auto", "search", "ranking", "detail", "supplier" ], "type": "string", "description": "Auto selects detail for product URLs or offer IDs, supplier for member IDs, and search for a keyword. Select ranking explicitly to collect a ranking tab without a keyword.", "default": "auto" }, "keyword": { "title": "Search keyword", "type": "string", "description": "Enter one product phrase, preferably in English for the Global catalog. Leaving all target fields empty starts the three-row phone case example, with normal charges." }, "offerIds": { "title": "Offer IDs", "type": "array", "description": "Enter numeric 1688 product IDs, such as the digits in detail.1688.com/offer/123456789.html. Direct details retain their source language and CNY prices.", "items": { "type": "string" } }, "startUrls": { "title": "Detail URLs", "type": "array", "description": "Enter 1688 product URLs containing /offer/.html or an offerId query parameter. Shop and category URLs are not product targets.", "items": { "type": "string", "pattern": "^https?://([A-Za-z0-9-]+\\.)*1688\\.com/.*$" } }, "memberIds": { "title": "Supplier member IDs", "type": "array", "description": "Enter supplier member IDs, including b2b- IDs or older alphanumeric IDs. Do not enter shop URLs.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum rows per keyword or ID", "minimum": 1, "maximum": 100, "type": "integer", "description": "Most rows to deliver for each keyword, product ID or supplier member ID, from 1 to 100; default 70. Your maximum charge limits the whole run; Free Apify plan users are limited by the developer to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "Number of Global search pages to check, from 1 to 5. Collection can stop sooner when the requested row limit is reached.", "default": 1 }, "rankingName": { "title": "Ranking", "enum": [ "Most_Popular", "New_Arrivals", "Trending", "Ranked_by_L30_Days_Total_Orders" ], "type": "string", "description": "Choose the ranking tab to read when mode is ranking.", "default": "Most_Popular" }, "categoryId": { "title": "Ranking category ID", "pattern": "^[0-9]+$", "type": "string", "description": "Enter the numeric category ID used by the ranking page, such as 54.", "default": "54" }, "categoryLevel": { "title": "Category level", "minimum": 1, "maximum": 3, "type": "integer", "description": "Category depth for the ranking filter, from 1 to 3.", "default": 1 }, "countryCode": { "title": "Ranking country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country filter for rankings, such as CN or US. This does not change the search market.", "default": "CN" }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Add available product specifications, SKU prices, images, shipping and ratings to search or ranking rows. Enabled by default; CNY details do not overwrite USD search prices.", "default": true }, "maxDetailItems": { "title": "Maximum detail attempts", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum search or ranking rows to enrich with details, up to 20 and no more than maxResults. Use at least 1 when includeDetails is enabled; direct detail mode attempts all selected products.", "default": 1 }, "includeLeads": { "title": "Include supplier contacts and company profiles", "type": "boolean", "description": "Add available supplier contacts and company fields to product rows; defaults to includeDetails. Supplier mode always attempts supplier information." }, "maxLeadItems": { "title": "Maximum supplier enrichment rows", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum search or ranking rows to enrich with supplier information, up to 100 and no more than maxResults. Defaults to maxDetailItems; supplier mode attempts all selected suppliers." }, "includeDescription": { "title": "Include detail description and images", "type": "boolean", "description": "Include available product description text and images when collecting product details.", "default": true }, "includeContactInfo": { "title": "Include extra contact information", "type": "boolean", "description": "Attempt additional published landline and fax details. Requires includeLeads; unavailable contacts remain empty.", "default": false }, "proxyCountry": { "title": "Global catalog country setting", "enum": [ "US" ], "type": "string", "description": "Leave US selected for the Global English/USD catalog. No proxy setup is needed.", "default": "US" } } }, "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 } } } } } } } } } }