{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Scraper - Alibaba Wholesale Prices, MOQ & Suppliers",
    "description": "Scrape 1688.com (Alibaba China wholesale) without login: products by keyword in English or Chinese, price, quantity price tiers, MOQ, sold count, supplier company, scores and province. Optional full product page: variants, attributes, images, video, delivery days.",
    "version": "0.1",
    "x-build-id": "8mwbro7WYb1oxcTfl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapewise~alibaba-1688-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapewise-alibaba-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/scrapewise~alibaba-1688-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapewise-alibaba-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/scrapewise~alibaba-1688-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapewise-alibaba-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": "What to search on 1688, one per line. English works (1688 translates it, for example 'phone case', 'yoga mat', 'led strip'); Chinese gives the most precise results (手机壳, 瑜伽垫, 灯带). Each keyword returns up to about 2,000 products, the most 1688 shows for one search.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max products",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many products in the whole run, across all keywords, images and links. Empty or 0 = no total limit (each keyword then stops at 60 unless you set 'Max products per keyword', and each image at 'Max products per image'). You pay per product delivered."
          },
          "maxItemsPerKeyword": {
            "title": "Max products per keyword (optional)",
            "minimum": 0,
            "type": "integer",
            "description": "Cap for each keyword, so one keyword does not use the whole 'Max products'. Empty = no cap per keyword when 'Max products' is set, or 60 when it is not. 0 = no cap (up to about 2,000)."
          },
          "imageUrls": {
            "title": "Image links (search by image)",
            "type": "array",
            "description": "Find 1688 suppliers from a product photo, one link per line: any public JPG, PNG or WebP (Amazon, AliExpress, Shopee, Temu, your own site, 1688). Each image returns similar 1688 products, most similar first, with the same fields as a keyword search plus 'similarityScore'.",
            "items": {
              "type": "string"
            }
          },
          "imageFile": {
            "title": "Or upload one image",
            "type": "string",
            "description": "Upload a product photo from your computer instead of a link."
          },
          "similarToOffers": {
            "title": "Similar to these 1688 products",
            "type": "array",
            "description": "1688 product links or offer ids: the Actor takes each product's main photo and finds other suppliers selling the same or similar item. Good for finding a cheaper factory for a product you already know.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerImage": {
            "title": "Max products per image",
            "minimum": 0,
            "type": "integer",
            "description": "Products returned for each image. Empty = 20. Each image search is charged once and includes up to 60 products; from the 61st on, products are charged one by one. 0 = all 1688 shows (about 700)."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "price_low",
              "price_high",
              "sales"
            ],
            "type": "string",
            "description": "Order 1688 applies to the search. 'relevance' is 1688's default order.",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at or above this, in Chinese yuan. Sent to 1688 and checked again on every product; products outside the range are not charged."
          },
          "maxPrice": {
            "title": "Max price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at or below this, in Chinese yuan."
          },
          "province": {
            "title": "Supplier province",
            "type": "string",
            "description": "Only suppliers from one Chinese province, in English or Chinese: Guangdong (广东), Zhejiang (浙江), Jiangsu, Fujian, Shandong, Hebei, Shanghai... Empty = all of China."
          },
          "excludeAds": {
            "title": "Leave out sponsored listings",
            "type": "boolean",
            "description": "1688 mixes paid placements into the results (isAd: true). On: they are skipped and not charged.",
            "default": false
          },
          "offerUrls": {
            "title": "Product links or ids",
            "type": "array",
            "description": "One per line: 1688 product links (https://detail.1688.com/offer/927875250705.html, the mobile m.1688.com/offer/... link) or just the numeric offer id. Each one returns the full product page. Also accepts 'startUrls' and 'offerIds'.",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Include full product page",
            "type": "boolean",
            "description": "Opens each product found by the search and adds variants with photos, all attributes (material, models, style...), full image gallery, video, price tiers, stock, want-to-buy count, ships-from, delivery days and buyer protections. Charged as one extra 'full product page' event per product that came back with it. Links and ids always open the full page.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxy is the default: a new IP is used whenever 1688 refuses one. If the datacenter keeps being refused, the Actor switches to a residential IP in China for that request, at no extra cost to you.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}