{
  "openapi": "3.0.1",
  "info": {
    "title": "1688.com Products Scraper",
    "description": "1688.com Products Scraper SD - 1688.com Products Scraper is a logged-out tool that extracts 1688.com wholesale products by keyword, offer ID or URL: price tiers, MOQ, stock, SKUs, sold count, repurchase rate, supplier, location, images and description.",
    "version": "1.0",
    "x-build-id": "D9hJTO6UFkGWvoS7K"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/neuro-scraper~1688-com-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-neuro-scraper-1688-com-products-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/neuro-scraper~1688-com-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-neuro-scraper-1688-com-products-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/neuro-scraper~1688-com-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-neuro-scraper-1688-com-products-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": "What you would type into the 1688 search box, one per line. Chinese keywords work best (English works too, with fewer related searches). Each keyword reads 1688's public sponsored-results page (20 offers) and, if more are wanted, 1688's own related searches that contain your keyword. Example: 手机壳",
            "items": {
              "type": "string"
            }
          },
          "offerIds": {
            "title": "Offer IDs",
            "type": "array",
            "description": "1688 offer IDs (the number in detail.1688.com/offer/<ID>.html), one per line. Each one gives one product row with every field. Example: 927875250705",
            "items": {
              "type": "string"
            }
          },
          "offerUrls": {
            "title": "Offer URLs",
            "type": "array",
            "description": "1688 product page URLs such as https://detail.1688.com/offer/927875250705.html (m.1688.com offer links work too). One product row each.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxProducts": {
            "title": "Max products per keyword",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many products to return for each keyword. The first 20 come from the keyword's own results page; more come from 1688's related searches (see below). Example: 20",
            "default": 20
          },
          "maxItems": {
            "title": "Max items (total)",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum number of product rows for the whole run (all keywords and offers together). Example: 50",
            "default": 50
          },
          "expandRelatedKeywords": {
            "title": "Use 1688's related searches for more results",
            "type": "boolean",
            "description": "1688 shows 20 offers per keyword page to logged-out visitors and its next-page request is signed, so more results are taken from the related searches 1688 lists on the page (only those that contain your keyword, e.g. 苹果手机壳 for 手机壳). Off = at most 20 per keyword.",
            "default": true
          },
          "maxRelatedKeywords": {
            "title": "Max related searches per keyword",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Safety limit on related-search pages read per keyword (one request each). Example: 10",
            "default": 10
          },
          "includeDetails": {
            "title": "Open each product page (full details)",
            "type": "boolean",
            "description": "For keyword results: open every product's page to add price tiers, MOQ, stock, unit weight, category, attributes, review count and good rate, seller details, location (province / city), delivery promise and services. One extra request per product. Offer IDs / URLs always get full details.",
            "default": true
          },
          "includeSkuDetails": {
            "title": "Include SKU variants",
            "type": "boolean",
            "description": "Add skuProps (option names and values with images) and skus (each variant's spec, stock, sales, promotion flag and package size). Needs product pages (on for offer IDs / URLs, or with full details).",
            "default": false
          },
          "includeDescriptionHtml": {
            "title": "Include full description HTML",
            "type": "boolean",
            "description": "Download each product's description (one extra small request) and add descriptionHtml, descriptionImages and descriptionText. Many 1688 descriptions are images only, so descriptionText is often empty.",
            "default": false
          },
          "sortBy": {
            "title": "Sort results by",
            "enum": [
              "relevance",
              "bestSelling",
              "priceAsc",
              "priceDesc",
              "repurchaseRate"
            ],
            "type": "string",
            "description": "Order of the returned products per keyword. 1688's logged-out results page ignores sort parameters (measured), so the Actor collects up to twice the wanted number of offers first and sorts them itself. Example: priceAsc",
            "default": "relevance"
          },
          "priceMin": {
            "title": "Minimum price (CNY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keyword results only: skip offers whose lowest price is below this (checked by the Actor - 1688's logged-out page ignores price parameters). 0 = no minimum. Example: 5",
            "default": 0
          },
          "priceMax": {
            "title": "Maximum price (CNY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keyword results only: skip offers whose lowest price is above this (checked by the Actor). 0 = no maximum. Example: 50",
            "default": 0
          },
          "minOrderQuantity": {
            "title": "Maximum acceptable MOQ",
            "minimum": 0,
            "type": "integer",
            "description": "Keyword results only: skip offers whose minimum order quantity is higher than this (read from the product page, so product pages are opened). 0 = any MOQ. Example: 10",
            "default": 0
          },
          "merchantType": {
            "title": "Supplier type",
            "enum": [
              "any",
              "verifiedMerchant",
              "superFactory"
            ],
            "type": "string",
            "description": "Keyword results only: keep offers from 1688 Verified / Powerful merchants (实力商家) or Super Factories (超级工厂), as shown by 1688's own badges on the offer.",
            "default": "any"
          },
          "province": {
            "title": "Supplier province",
            "type": "string",
            "description": "Keyword results only: keep offers shipped from this province, in Chinese as on 1688 (广东, 浙江, 福建 ...). Read from the product page. Empty = any. Example: 广东"
          },
          "city": {
            "title": "Supplier city",
            "type": "string",
            "description": "Keyword results only: keep offers shipped from this city, in Chinese (义乌, 深圳, 广州 ...). Read from the product page. Empty = any. Example: 深圳"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Residential proxy in China is the default (1688 is a Chinese domestic site; China and Hong Kong residential IPs were measured to work). A slider page is never answered - the Actor switches to a new IP instead.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "CN"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}