{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Scraper | Products, Reviews, Details, Wholesale Prices",
    "description": "Scrape 1688.com, Alibaba's Chinese wholesale marketplace, by keyword (English or Chinese) or offer ID. Get tiered pricing, MOQ, specs, color and size variants, verified supplier details, after-sales guarantees and buyer reviews. Built for dropshipping, Amazon FBA and private-label sourcing.",
    "version": "1.0",
    "x-build-id": "LfernswJX32z3Hkls"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~1688-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-1688-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/silentflow~1688-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-1688-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/silentflow~1688-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-1688-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": "Products to search on 1688, one keyword per line, in English (<code>iphone case</code>, <code>wireless earbuds</code>) or Chinese (<code>手机壳</code>, <code>蓝牙耳机</code>). Each keyword is searched on its own and Max results applies per keyword. Chinese keywords usually return more and better-matched products, since 1688 is a domestic Chinese marketplace. 1688 lists up to 2,000 products per keyword.",
            "items": {
              "type": "string"
            }
          },
          "offerIds": {
            "title": "🆔 Offer IDs",
            "type": "array",
            "description": "Specific products to scrape directly, by the number in their 1688 address (<code>735353578254</code> from <code>detail.1688.com/offer/735353578254.html</code>). Can be combined with keywords. Offer IDs are scraped as given: the filters below apply to keyword search only.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "🔢 Max results per keyword",
            "minimum": 1,
            "type": "integer",
            "description": "How many products to save per keyword. With filters on, the run reads further into the results until it has this many matching products or 1688 runs out. Cost scales with the rows delivered, so set it to what you need.",
            "default": 100
          },
          "sortBy": {
            "title": "↕️ Sort order",
            "enum": [
              "relevance",
              "bestSelling",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "How 1688 orders the search results. <code>Best selling</code> puts the products with the most orders first.",
            "default": "relevance"
          },
          "minPrice": {
            "title": "💴 Min price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Lowest unit price you want, in Chinese yuan (<code>10</code>). A product is kept when any of its prices (the MOQ price, a bulk tier or a promotion) reaches the range. Leave empty for no floor."
          },
          "maxPrice": {
            "title": "💴 Max price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Highest unit price you want, in Chinese yuan (<code>20</code>). A product is kept when any of its prices (the MOQ price, a bulk tier or a promotion) is at or below it. Leave empty for no ceiling."
          },
          "maxMoq": {
            "title": "📦 Max MOQ",
            "minimum": 0,
            "type": "integer",
            "description": "Largest minimum order quantity you accept (<code>1</code> keeps only suppliers that sell single units, for samples and dropshipping; <code>50</code> keeps offers you can order from 50 units or fewer). Leave empty for no limit."
          },
          "supplierType": {
            "title": "🏭 Supplier type",
            "enum": [
              "any",
              "manufacturer",
              "wholesaler",
              "inspectedFactory",
              "verifiedMerchant"
            ],
            "type": "string",
            "description": "Keep only one kind of supplier. <code>Manufacturer</code> (生产加工) and <code>Wholesaler</code> (经销批发) are the business model the supplier declares to 1688. <code>Inspected factory</code> keeps suppliers whose factory 1688 inspected on site (深度验厂). <code>Verified merchant</code> keeps suppliers with 1688's 实商 badge. Rarer types return fewer products per page, so the run reads more pages to fill Max results.",
            "default": "any"
          },
          "supplierCity": {
            "title": "📍 Supplier city",
            "type": "string",
            "description": "Keep only suppliers based in one city. The English names of the main sourcing hubs work (<code>Shenzhen</code>, <code>Guangzhou</code>, <code>Dongguan</code>, <code>Yiwu</code>, <code>Ningbo</code>, <code>Shantou</code>, <code>Quanzhou</code>...); any other city can be typed in Chinese (<code>深圳</code>, <code>临沂</code>). A county-level city such as Yiwu shows its parent city in the province field (金华). Leave empty for all of China."
          },
          "includeSkuMatrix": {
            "title": "🎨 Include per-variant stock and price",
            "type": "boolean",
            "description": "Also fetch the per-variant matrix (each color and size with its own stock and price). This adds time. Available colors and sizes, tiered pricing, reviews and supplier details come on every product regardless. Leave off for the fastest runs.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}