{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Image Search Scraper: Find Products by Photo",
    "description": "Find 1688.com products by photo: give an image link or a 1688 offer and get visually similar products from other sellers, cheapest first, with similarity score, tiered prices, MOQ, stock, sales and supplier. Any image works. No login. Pay only for results.",
    "version": "0.1",
    "x-build-id": "LZCydGdwZTfyQPZHe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/theshark~1688-image-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-theshark-1688-image-search-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-image-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-theshark-1688-image-search-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-image-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-theshark-1688-image-search-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": {
          "imageUrls": {
            "title": "Image URLs (search by photo)",
            "type": "array",
            "description": "Links to photos to search by: 1688 finds visually similar products. Links on alicdn.com (1688 product images) are used directly; any other image is downloaded, resized and uploaded to 1688 (JPEG, PNG, GIF and WEBP work). Each image is searched separately, up to about 700 products per image. Every row has similarityScore: smaller is closer (for example, below 0.1 is almost the same photo).",
            "items": {
              "type": "string"
            }
          },
          "similarToOfferIds": {
            "title": "Find look-alikes of offers (IDs or URLs)",
            "type": "array",
            "description": "1688 product IDs or links. For each one, the scraper takes its main image and finds visually the same or very close products from other sellers, cheapest first (up to about 700 per offer), then scrapes them as normal products. The offer itself is not included. Every row has similarityScore: smaller is closer. Only products with similarityScore up to 0.2 are kept (about the same photo or the same kind of product); change this with Max similarityScore.",
            "items": {
              "type": "string"
            }
          },
          "maxSimilarityScore": {
            "title": "Max similarityScore (look-alikes)",
            "minimum": 0,
            "type": "number",
            "description": "Only for 'Find look-alikes of offers'. Products with a higher similarityScore are skipped. Smaller means closer: up to 0.1 is almost the same photo, 0.1-0.2 is the same kind of product, above 0.3 are often different models. Leave empty for the default 0.2, which suits most goods; fashion and other visual categories may need a higher value (for example 0.3)."
          },
          "maxResults": {
            "title": "Max results per photo or offer",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of products per photo or look-alike offer. 1688 returns up to about 700 products per photo.",
            "default": 100
          },
          "scrapeProductPages": {
            "title": "Open product pages",
            "type": "boolean",
            "description": "On (default): every product is scraped from its own page, with the full set of fields. Off: products are taken straight from the photo search results, which is much faster and cheaper (billed as the cheaper product-card event); such rows have the search-card fields (title, price tiers, image, seller, sales, similarityScore). Reviews, supplier intelligence and same items need product pages.",
            "default": true
          },
          "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."
          },
          "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 a type of supplier.",
            "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."
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Skip products whose title contains any of these words.",
            "items": {
              "type": "string"
            }
          },
          "includeSkuDetails": {
            "title": "Include SKU details",
            "type": "boolean",
            "description": "Add the full variant matrix: each variant with its options, price, stock and sales.",
            "default": false
          },
          "includeDescriptionHtml": {
            "title": "Include description HTML",
            "type": "boolean",
            "description": "Add the full product description as HTML. Description text and images are always included.",
            "default": false
          },
          "includeReviews": {
            "title": "Reviews per product",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "How many latest reviews to attach to each product (0 to 100). 1688 shows anonymous visitors only part of a product's reviews, so some products get fewer. Buyer names, avatars and profiles are never collected. Charged per review delivered.",
            "default": 0
          },
          "includeSupplierIntelligence": {
            "title": "Include supplier intelligence",
            "type": "boolean",
            "description": "Add a supplierIntelligence block: factory card for verified factories (videos, rankings, equipment list, production lines, OEM minimums, production capacity, factory address and coordinates), product certificates (including CE/FCC/RoHS), customization (services with prices, printing price list, lead times by quantity), dropshipping metrics and the product's ranking on 1688. Up to 6 extra requests per product. Charged as an extra event only when at least part of this data is found. Always included for free: founding year, company registration with address, supplier profile (staff, area, equipment, verification), shop metrics (stars, quality and fulfilment rates, followers, years on 1688) and the seller chat link.",
            "default": false
          },
          "includeSameItems": {
            "title": "Include same items from other sellers",
            "type": "boolean",
            "description": "Add a sameItems list to each product: up to 8 offers of the same item from other sellers (title, price, sales text, image and link; no seller details). Billed as a same-items event only when the list is not empty. Needs product pages, so it is off when scrapeProductPages is false.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}