{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Image Search Scraper",
    "description": "Find any product on 1688.com by photo: paste image links from Amazon, AliExpress, Shopify or your own pictures and get the matching factory listings with price in CNY and USD, units sold, repeat-buyer rate, English title and supplier details. Source products from China.",
    "version": "0.1",
    "x-build-id": "phNcFl3OfI2cBmqJB"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/blueskyscraper~1688-image-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-blueskyscraper-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/blueskyscraper~1688-image-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-blueskyscraper-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/blueskyscraper~1688-image-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-blueskyscraper-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": {
          "mode": {
            "title": "🧭 What to get",
            "enum": [
              "image"
            ],
            "type": "string",
            "description": "<b>Products</b> — 1688 search results: title (with English translation), price in CNY and USD, units sold, repeat-buyer rate, the factory or wholesaler with years, province and audit badges. <b>Product details</b> — the full product page: price range, minimum order, stock, variants with images, specifications, weight, ship-from city, services. <b>Image search</b> — products that look like your photo. <b>Suppliers</b> — one row per factory or wholesaler selling a product.",
            "default": "image"
          },
          "imageUrls": {
            "title": "🖼️ Image URLs",
            "type": "array",
            "description": "For <b>Image search</b>: links to product photos (.jpg, .png, .webp) — an Amazon, AliExpress, Shopify or your own picture. 1688 returns the factories selling the same or a similar item.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 1688 URLs",
            "type": "array",
            "description": "Any 1688 link, routed automatically: a search results page (<code>s.1688.com/selloffer/offer_search.htm?keywords=…</code>), a product page, or an image link.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerInput": {
            "title": "💯 Results per keyword, image or URL",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap for each keyword, image or URL, not for the whole run. 1688 shows up to ~3,000 products per search (60 per page).",
            "default": 60
          },
          "minPriceCny": {
            "title": "💴 Minimum price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Products cheaper than this are skipped (free). 1 USD ≈ 7.1 CNY."
          },
          "maxPriceCny": {
            "title": "💴 Maximum price (CNY)",
            "minimum": 0,
            "type": "number",
            "description": "Products dearer than this are skipped (free)."
          },
          "manufacturersOnly": {
            "title": "🏭 Factories only",
            "type": "boolean",
            "description": "Keep only suppliers registered as manufacturers (生产加工) or with an on-site factory audit.",
            "default": false
          },
          "provinces": {
            "title": "📍 Provinces or cities",
            "type": "array",
            "description": "Only suppliers from these places, in Chinese: <code>浙江</code> (Zhejiang), <code>广东</code> (Guangdong), <code>义乌</code> (Yiwu), <code>深圳</code> (Shenzhen). Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "↕️ Order",
            "enum": [
              "bestMatch",
              "sales"
            ],
            "type": "string",
            "description": "1688's best match, or best-selling first (sales in the last 30 days).",
            "default": "bestMatch"
          },
          "excludeAds": {
            "title": "🚫 Skip sponsored listings",
            "type": "boolean",
            "description": "Leave out products placed by paid ads (marked <code>isAd</code>). Skipped rows are free.",
            "default": false
          },
          "includeDetails": {
            "title": "📋 Open each product page ($0.003 per row)",
            "type": "boolean",
            "description": "Products and Image search: one full product-page row per result — variants with images, specifications, stock, weight, ship-from city, services — billed as a product page.",
            "default": false
          },
          "includeVariants": {
            "title": "🧩 Variants, reviews and factory on product pages",
            "type": "boolean",
            "description": "Product pages also get <b>every variant (SKU) with its own price and stock</b>, the <b>rating summary</b> with review tags and the latest reviews, and the <b>factory profile</b> — founded, staff, factory area, equipment, OEM/ODM, response rate, certifications. Included in the product-page price.",
            "default": true
          },
          "translateToEnglish": {
            "title": "🌐 Add English translations",
            "type": "boolean",
            "description": "Titles, specifications, variants, tags and company names get an English copy next to the Chinese original (<code>titleEn</code>, <code>attributesEn</code>…). Included in the price.",
            "default": true
          },
          "maxItems": {
            "title": "Maximum rows per run",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop after this many rows in the whole run — a hard ceiling on cost.",
            "default": 10000
          },
          "monitoringStoreName": {
            "title": "🔔 Monitoring mode — store name",
            "type": "string",
            "description": "Give the run a name (e.g. <code>new-yoga-mats</code>) and every later run with the same name returns <b>only rows it has not delivered before</b> — new products, new suppliers. Schedule it daily. Empty = normal run."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}