{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Supplier Scraper — Factories & Wholesalers · $2/1k",
    "description": "Find the factories and wholesalers selling any product on 1688.com, by keyword or photo, or read every product of a supplier you name. One row per supplier with location, factory badges, year founded, factory size, staff, patents, rating and service scores. $2 per 1,000 rows.",
    "version": "1.0",
    "x-build-id": "e6DwTs8fzjqddWh9B"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~1688-supplier-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-1688-supplier-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/memo23~1688-supplier-scraper/runs": {
      "post": {
        "operationId": "runs-sync-memo23-1688-supplier-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/memo23~1688-supplier-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-1688-supplier-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": {
          "searchQueries": {
            "title": "Products to find suppliers for",
            "type": "array",
            "description": "Product keywords, one per line, in English or Chinese: yoga mat, phone case, 蓝牙耳机. English is translated to the Chinese words 1688 matches best. Each keyword returns the factories and wholesalers selling it, most offers first.",
            "items": {
              "type": "string"
            }
          },
          "imageUrls": {
            "title": "Product photos",
            "type": "array",
            "description": "Links to product photos (an Amazon, AliExpress or Shopify picture, or your own). Each photo returns the suppliers selling something that looks like it.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "1688 search links",
            "type": "array",
            "description": "Optional. A 1688 search results link (s.1688.com/selloffer/offer_search.htm?keywords=...) is read like a keyword. An offer link adds that offer's supplier.",
            "items": {
              "type": "string"
            }
          },
          "maxSuppliers": {
            "title": "Max suppliers per keyword",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many suppliers each keyword, photo or search link returns, the ones with the most matching offers first. Each supplier is one billed row.",
            "default": 50
          },
          "includeCompanyProfile": {
            "title": "Company profile",
            "type": "boolean",
            "description": "Add each supplier's factory profile to its row: year founded, factory area, employees, production lines, patents, certificates, the company that audited the factory, brands it makes for, export markets, response and on-time delivery rates, rating and followers. Suppliers without a profile on 1688 get empty fields. No extra charge.",
            "default": true
          },
          "supplierShops": {
            "title": "Supplier shops",
            "type": "array",
            "description": "One per line: the supplierId from a row of this actor (shengdecn, b2b-2217636012473...), the supplier's name.1688.com link, or any product link from that shop. A shopNNNN.1688.com link does not say which supplier it is; paste a product link from that shop instead.",
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerShop": {
            "title": "Max products per shop",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Products read from each supplier shop, in the order below. Each product is one billed row. The free Apify plan reads up to 100 per shop.",
            "default": 200
          },
          "shopSort": {
            "title": "Order of shop products",
            "enum": [
              "default",
              "newest",
              "sales",
              "priceAsc"
            ],
            "type": "string",
            "description": "Which products come first when a shop has more than Max products per shop.",
            "default": "default"
          },
          "manufacturersOnly": {
            "title": "Manufacturers only",
            "type": "boolean",
            "description": "Keep only manufacturers: suppliers listed as 生产加工 (production), super factories (超级工厂) and on-site inspected factories. Traders and wholesalers are left out.",
            "default": false
          },
          "locations": {
            "title": "Supplier locations",
            "type": "array",
            "description": "Keep only suppliers whose location contains one of these, in Chinese: 浙江 (Zhejiang), 广东 (Guangdong), 义乌 (Yiwu), 深圳 (Shenzhen). A province matches every city in it. Empty keeps every location.",
            "items": {
              "type": "string"
            }
          },
          "priceMin": {
            "title": "Min unit price (CNY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only offers priced at or above this, in yuan. Offers whose card shows no price are kept."
          },
          "priceMax": {
            "title": "Max unit price (CNY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only offers priced at or below this, in yuan."
          },
          "excludeAds": {
            "title": "Skip sponsored offers",
            "type": "boolean",
            "description": "Leave out offers placed by paid ads (isAd: true). Skipped offers are not billed.",
            "default": false
          },
          "excludeKeywords": {
            "title": "Exclude words in title",
            "type": "array",
            "description": "Drop offers whose title contains any of these words, Chinese or English, case-insensitive. Useful when a keyword has a second meaning, e.g. 夹板 also matches 电夹板 hair straighteners. Dropped offers are not billed.",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort search results by",
            "enum": [
              "default",
              "sales",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Order of 1688's search before suppliers are grouped: best match, or best-selling first.",
            "default": "default"
          },
          "translateKeywords": {
            "title": "Translate English keywords to Chinese",
            "type": "boolean",
            "description": "Search queries written in English (yoga mat, phone case) are machine-translated to the Chinese words 1688 matches best before searching. Each row keeps the Chinese keyword in sourceQuery and your original in sourceQueryOriginal. Chinese queries are searched as typed.",
            "default": true
          },
          "translateToEnglish": {
            "title": "English translation",
            "type": "boolean",
            "description": "Add supplierNameEn and English titles of the sample offers, machine-translated from the Chinese. The Chinese originals stay in the row.",
            "default": true
          },
          "proxy": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Residential proxies recommended. The default works out of the box; set your own only if you have one."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}