{ "openapi": "3.0.1", "info": { "title": "Product Search by Image (1688/Alibaba/AliExpress)", "description": "Product Search by Image (1688/Alibaba/AliExpress) SD - Product Search by Image (1688/Alibaba/AliExpress) is a reverse image search tool that extracts matching AliExpress and Alibaba.com products for any photo: price, MOQ, rating, sold count, supplier and rank.", "version": "1.0", "x-build-id": "OMkQBut00bugB0Eqi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~product-search-by-image/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-product-search-by-image", "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/neuro-scraper~product-search-by-image/runs": { "post": { "operationId": "runs-sync-neuro-scraper-product-search-by-image", "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/neuro-scraper~product-search-by-image/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-product-search-by-image", "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", "type": "array", "description": "Product photos to search with, one per line: a direct image link (JPG, PNG, WEBP or BMP) or a data:image/...;base64 URL. Each photo is uploaded to the marketplaces' own 'search by image' and gets its own list of matches. Example: https://images.unsplash.com/photo-1542291026-7eec264c27ff?w=400", "items": { "type": "string" } }, "imageUrl": { "title": "Image URL (single)", "type": "string", "description": "One photo URL, for callers that send a single image (same as one line of Image URLs). Example: https://cbu01.alicdn.com/img/ibank/15418323391_1847764777.jpg" }, "imagesBase64": { "title": "Images as base64", "type": "array", "description": "Photos you have as files: a list of base64 strings, data: URLs or {\"base64\": \"...\"} objects. Example: [\"/9j/4AAQSkZJRg...\"]" }, "marketplaces": { "title": "Marketplaces", "type": "array", "description": "Where to search. AliExpress (retail, one item) and Alibaba.com (wholesale suppliers, MOQ). 1688.com is not offered: its image search needs a login or a slider check for visitors who are not logged in (measured 2026-10-09).", "items": { "type": "string", "enum": [ "aliexpress", "alibaba" ], "enumTitles": [ "AliExpress", "Alibaba.com" ] }, "default": [ "aliexpress", "alibaba" ] }, "maxResultsPerImage": { "title": "Max matches per image and marketplace", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many matching products to return for each photo on each marketplace. The Actor follows the marketplace's result pages (AliExpress 60 per page, usually 100-150 matches in all; Alibaba 48 per page, several hundred). Example: 60", "default": 60 }, "maxImages": { "title": "Max images", "minimum": 1, "maximum": 200, "type": "integer", "description": "Only the first N photos of the input are searched. Example: 10", "default": 10 }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of match rows for the whole run (all photos and marketplaces). Example: 500", "default": 500 }, "sort": { "title": "Sort (AliExpress)", "enum": [ "best_match", "orders", "price_asc", "price_desc" ], "type": "string", "description": "Order of AliExpress matches, applied by AliExpress itself. Sorted lists hold the 60 best matches re-ordered (measured). Alibaba always returns its matches by similarity.", "default": "best_match" }, "currency": { "title": "Currency (AliExpress)", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "BRL", "AUTO" ], "type": "string", "description": "Currency of AliExpress prices, set through AliExpress's own currency switcher. AUTO = the proxy country's currency. Alibaba.com shows prices in the proxy country's currency (USD with the default US proxy); the currency field says which.", "default": "USD" }, "shipTo": { "title": "Ship-to country (AliExpress)", "type": "string", "description": "Two-letter country code AliExpress prices and availability are shown for. Example: US", "default": "US" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy in the United States is the default (measured working for both marketplaces). A slider page is never answered - the Actor switches to a new IP instead.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }