{ "openapi": "3.0.1", "info": { "title": "1688 Image Search API: Photo to Factory Matches and Prices", "description": "Search 1688 by image to find the factory or supplier of a product: send photo URLs, receive the similar 1688.com offers in rank order with CNY price, minimum order, sold count, supplier type, region and years. $4 per 1,000 photos + $0.40 per 1,000 matches. Ads and failed photos free.", "version": "1.0", "x-build-id": "NklXuSGJG9d68syg9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tenfoldfleet~1688-image-search-suppliers-by-photo/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tenfoldfleet-1688-image-search-suppliers-by-photo", "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/tenfoldfleet~1688-image-search-suppliers-by-photo/runs": { "post": { "operationId": "runs-sync-tenfoldfleet-1688-image-search-suppliers-by-photo", "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/tenfoldfleet~1688-image-search-suppliers-by-photo/run-sync": { "post": { "operationId": "run-sync-tenfoldfleet-1688-image-search-suppliers-by-photo", "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", "required": [ "imageUrls" ], "properties": { "imageUrls": { "title": "Product photo URLs", "type": "array", "description": "Web addresses of the product pictures to look up, one per line. Any public picture works: a listing photo from Amazon, Shopify, Temu, AliExpress or 1688, or a file on your own server. Formats: JPG, PNG, WebP, GIF, AVIF; limit 10 MB per file and 1,000 photos per run. A product shown alone gives the best matches. A photo that fails or has no match is free.", "items": { "type": "string" } }, "maxResultsPerImage": { "title": "Max matches per photo", "minimum": 1, "maximum": 600, "type": "integer", "description": "Upper limit of 1688 listings delivered per photo, in 1688's rank order (1688 holds about 700 per photo). Price: $0.004 for a photo that has a match, then $0.0004 per match, so 60 matches of one photo are $0.028. Free plan: Apify's $5 of monthly credit pays for roughly 175 photos at 60 matches each.", "default": 60 }, "includeAds": { "title": "Include paid ads", "type": "boolean", "description": "A share of every 1688 image results page is sponsored. Those listings are dropped unless you switch this on. When on, they are delivered with isAd: true, cost nothing and are not counted in the max.", "default": false }, "includeProductDetails": { "title": "Open product pages", "type": "boolean", "description": "Read the 1688 product page of the top matches and attach a details object: quantity price tiers, minimum order, stock, specifications, the full photo set, video, ship-from city and unit weight. $0.003 per page that is read; a page that cannot be read is free.", "default": false }, "maxDetailsPerImage": { "title": "Product pages per photo", "minimum": 0, "maximum": 600, "type": "integer", "description": "Used with \"Open product pages\": the number of top matches per photo whose product page is read.", "default": 10 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of photos handled at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is. Searches go through Apify residential proxy, which is already paid by the event prices, because 1688 turns away datacenter addresses. Your own proxy URLs are accepted as an alternative.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }