{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Search Results Scraper: Fast Product Cards",
    "description": "Fast, low-cost 1688.com search scraper: products straight from the search results for your keywords, search links or category, up to 5,000 per query. Price tiers, MOQ, sales, supplier, region, trade scores and image. Filters on 1688's side. No login.",
    "version": "0.1",
    "x-build-id": "sIo03O35z28OalaCn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/theshark~1688-search-results-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-theshark-1688-search-results-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/theshark~1688-search-results-scraper/runs": {
      "post": {
        "operationId": "runs-sync-theshark-1688-search-results-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/theshark~1688-search-results-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-theshark-1688-search-results-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": "Keywords",
            "type": "array",
            "description": "Search keywords, Chinese or English, for example 手机壳 or phone case. Each keyword is searched separately.",
            "items": {
              "type": "string"
            }
          },
          "searchUrls": {
            "title": "1688 search URLs",
            "type": "array",
            "description": "Links to 1688 search results (s.1688.com/selloffer/offer_search.htm?..., m.1688.com/offer_search/...). The keyword and the filters from the link are used; they win over the filters below. Each link is searched separately.",
            "items": {
              "type": "string"
            }
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "1688 category ID of level 1 or 2 (for example 1813 for toys, 181309 for a sub-category). With keywords or links it works as a filter; alone it is searched by itself. Leaf categories need a keyword."
          },
          "maxResults": {
            "title": "Max results per keyword, link or category",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum number of products per keyword, link or category. One 1688 search gives up to 300 products. Above that, extra searches are made (split by price range and sort order), so the run takes longer and the extra results are less relevant.",
            "default": 100
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "bestSelling",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "How search results are ordered.",
            "default": "relevance"
          },
          "priceMin": {
            "title": "Minimum price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at or above this value, in yuan. Leave empty for no filter."
          },
          "priceMax": {
            "title": "Maximum price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at or below this value, in yuan. Leave empty for no filter."
          },
          "minOrderQuantityFrom": {
            "title": "Min minimum order quantity",
            "minimum": 0,
            "type": "integer",
            "description": "Only products whose minimum order quantity (MOQ) is at least this value. Leave empty for no filter."
          },
          "minOrderQuantity": {
            "title": "Max minimum order quantity",
            "minimum": 0,
            "type": "integer",
            "description": "Only products whose minimum order quantity (MOQ) is at most this value. Leave empty for no filter."
          },
          "merchantType": {
            "title": "Merchant type",
            "enum": [
              "any",
              "verifiedMerchant"
            ],
            "type": "string",
            "description": "Limit results to verified merchants (实力商家), with 1688's own search filter.",
            "default": "any"
          },
          "province": {
            "title": "Province",
            "type": "string",
            "description": "Filter by supplier province, in Chinese characters (for example 广东). Several provinces can be separated by commas (for example 江苏,浙江). Optional."
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "Filter by supplier city, in Chinese characters (for example 深圳). Optional."
          },
          "dropshipping": {
            "title": "Dropshipping (一件代发)",
            "type": "boolean",
            "description": "Only suppliers that ship single items directly to your customer.",
            "default": false
          },
          "freeShipping": {
            "title": "Free shipping (包邮)",
            "type": "boolean",
            "description": "Only products with free shipping. Cannot be combined with 'Dropshipping with free shipping'; the first one is used.",
            "default": false
          },
          "dropshipFreeShipping": {
            "title": "Dropshipping with free shipping (1件代发包邮)",
            "type": "boolean",
            "description": "Only products that ship single items with free shipping.",
            "default": false
          },
          "sevenDayReturn": {
            "title": "7-day return (7天无理由)",
            "type": "boolean",
            "description": "Only products with a 7-day no-reason return. Cannot be combined with 'Fast invoice'; the first one is used.",
            "default": false
          },
          "fastInvoice": {
            "title": "Fast invoice (极速开票)",
            "type": "boolean",
            "description": "Only suppliers that issue invoices quickly.",
            "default": false
          },
          "officialLogistics": {
            "title": "Official logistics (官方物流)",
            "type": "boolean",
            "description": "Only products shipped with 1688 official logistics.",
            "default": false
          },
          "verifiedFactory": {
            "title": "Verified factory (真实工厂认证)",
            "type": "boolean",
            "description": "Only suppliers with a verified factory. Cannot be combined with 'Big brand OEM' or the 'Verified merchant' type; the first one is used.",
            "default": false
          },
          "bigBrandOem": {
            "title": "Big brand OEM (大牌代工)",
            "type": "boolean",
            "description": "Only suppliers that make products for big brands.",
            "default": false
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Skip products whose title contains any of these words.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}