{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Scraper - Wholesale Products, Prices, MOQ & Suppliers",
    "description": "Scrape 1688.com wholesale products and suppliers by keyword, search link or offer ID. Filter by price, MOQ, supplier city and type; sort by price. Get tiered prices, sales, supplier rating and service scores, factory inspection, manufacturer vs wholesaler, stock, SKU options, attributes and images.",
    "version": "0.0",
    "x-build-id": "KXKAaWZDLxdPU3uaK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/piotrv1001~1688-listings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-piotrv1001-1688-listings-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/piotrv1001~1688-listings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-piotrv1001-1688-listings-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/piotrv1001~1688-listings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-piotrv1001-1688-listings-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": "Keywords to search on 1688.com, one per line. Chinese terms match the most products, but English also works. A 1688 search link works too (we read the keyword from it). Each keyword is searched independently.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "offerIds": {
            "title": "Offer IDs or links",
            "type": "array",
            "description": "Specific 1688 offers to scrape directly, as an ID (1095091629248) or a link (detail.1688.com/offer/1095091629248.html). Skips search and always opens the offer page.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of products to save across all keywords, split evenly between them (room a keyword does not use goes to the others). Set 0 for unlimited (1688 itself stops at 2,000 per keyword).",
            "default": 50
          },
          "maxPagesPerKeyword": {
            "title": "Max search pages per keyword",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "Optional limit of search-result pages (50 offers each) per keyword. Leave empty to continue until Max items or 1688's own limit of 2,000 results per keyword (40 pages)."
          },
          "includeDetails": {
            "title": "Include detail pages",
            "type": "boolean",
            "description": "If true, each offer found via search is followed to its detail page to capture tiered prices, attributes, MOQ, seller info, and after-sales policy. Disable for faster, lighter listing-only runs.",
            "default": false
          },
          "sortBy": {
            "title": "Sort by",
            "type": "string",
            "description": "Order of search results. Other spellings work too (price_asc, priceAsc, asc, desc).",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only offers priced at or above this, in Chinese yuan (CNY), e.g. 10."
          },
          "maxPrice": {
            "title": "Max price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only offers priced at or below this, in Chinese yuan (CNY), e.g. 20."
          },
          "maxMoq": {
            "title": "Max minimum order quantity (MOQ)",
            "minimum": 1,
            "type": "integer",
            "description": "Only offers you can buy in quantities this small or smaller, e.g. 1 for suppliers that sell single units (dropshipping, samples)."
          },
          "supplierCity": {
            "title": "Supplier city",
            "type": "string",
            "description": "Only suppliers based in this city. English names of the main sourcing hubs work (Shenzhen, Guangzhou, Yiwu, Dongguan, Ningbo, Shantou …); any other city in Chinese, e.g. 深圳 or 揭阳. A province typed here (Guangdong) filters on the province instead."
          },
          "supplierProvince": {
            "title": "Supplier province",
            "type": "string",
            "description": "Only suppliers in this province, in English or Chinese, e.g. Zhejiang or 浙江. Checked on each row, so only matching rows are saved and charged; the run reads more search pages to reach Max items."
          },
          "supplierType": {
            "title": "Supplier type",
            "type": "string",
            "description": "Only offers from this kind of supplier. Checked on each row, so only matching rows are saved and charged; the run reads more search pages to reach Max items.",
            "default": "any"
          },
          "excludeSponsored": {
            "title": "Skip sponsored offers",
            "type": "boolean",
            "description": "Leave out paid (sponsored) placements, which 1688 puts first on most searches. Checked on each row, so only organic results are saved and charged.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy for the first attempt of each search. Retries use other proxies automatically, so you normally do not need to change this.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}