1688 Cross-border Image Search API (V1)
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...
Searches 1688 cross-border products by image with language selection, pagination, sorting and sourcing filters. Use it to find products for multilingual visual sourcing.
Highlights
Guidance
Convert external images with Image Conversion using the corresponding cross-border image search target.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
token | query | string | Yes | - | Access token for this API service. |
imgUrl | query | string | Yes | - | Image URL or image reference returned by Image Conversion. Convert external images for the selected search target before searching. |
language | query | string | No | en | Output language. Available Values: - en: English- zh: Chinese- ru: Russian- th: Thai- pt: Portuguese- es: Spanish- tr: Turkish- vi: Vietnamese- ja: Japanese- ko: Korean |
page | query | integer | No | 1 | Page number, starting at 1. |
pageSize | query | integer | No | 20 | Number of items requested per page. The returned count may differ. |
sort | query | string | No | default | Product sort order. Available Values: - default: Default order- sales: Sales order- price_up: Price ascending- price_down: Price descending |
priceStart | query | string | No | - | Minimum price filter in CNY. |
priceEnd | query | string | No | - | Maximum price filter in CNY. |
supportDropshipping | query | boolean | No | - | Filter for support for dropshipping. |
isFactory | query | boolean | No | - | Filter by factory status. |
verifiedSupplier | query | boolean | No | - | Filter for verified sellers. |
freeShipping | query | boolean | No | - | Filter for free shipping. |
newArrival | query | boolean | No | - | Filter for new products. |
Code Samples
bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE'text
I want to use the "Cross-border Image Search (V1)" API from Just One API.
Base URL: https://api.justoneapi.com.
API Path: /api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE
API Endpoint: BASE_URL + /api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/1688/cross-border-product-search-by-image-v1-en.json
Parameters:
- token (query): Access token for this API service. (Required)
- imgUrl (query): Image URL or image reference returned by Image Conversion. Convert external images for the selected search target before searching. (Required)
- language (query): Output language.
Available Values:
- `en`: English
- `zh`: Chinese
- `ru`: Russian
- `th`: Thai
- `pt`: Portuguese
- `es`: Spanish
- `tr`: Turkish
- `vi`: Vietnamese
- `ja`: Japanese
- `ko`: Korean
- page (query): Page number, starting at 1.
- pageSize (query): Number of items requested per page. The returned count may differ.
- sort (query): Product sort order.
Available Values:
- `default`: Default order
- `sales`: Sales order
- `price_up`: Price ascending
- `price_down`: Price descending
- priceStart (query): Minimum price filter in CNY.
- priceEnd (query): Maximum price filter in CNY.
- supportDropshipping (query): Filter for support for dropshipping.
- isFactory (query): Filter by factory status.
- verifiedSupplier (query): Filter for verified sellers.
- freeShipping (query): Filter for free shipping.
- newArrival (query): Filter for new products.
Return format: safely handle JSON or text according to the actual Content-Type.
Response Handling & Error Codes:
1. Business results should be determined by the "code" field in the response body (code 0 means success).
2. Timeout Recommendation: Set the request timeout to 120 seconds. If 120 seconds is too long for your use case, use at least 60 seconds, but a small number of requests may time out before receiving a result.
3. Business Code Reference:
- 0: Success
- 100: Invalid or Inactive Token
- 301: Collection Failed. Please Retry.
- 302: Rate Limit Exceeded
- 303: Daily Quota Exceeded
- 400: Invalid Parameters
- 500: Internal Server Error
- 600: Permission Denied
- 601: Insufficient Balance
- 602: Token Budget Exceeded
4. Code 601 means the shared account balance is insufficient. Code 602 means the current API token's own cumulative budget limit has been reached. Token budget limits do not transfer funds out of the shared account balance.
Please help me write a script in my preferred programming language to call this API and handle the response.python
import requests
BASE_URL = "https://api.justoneapi.com" # Provided by OpenAPI servers
url = BASE_URL + "/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE"
response = requests.get(url, timeout=120)
print(response.status_code)
if response.content:
content_type = response.headers.get("content-type", "").lower()
if "json" in content_type:
try:
print(response.json())
except ValueError:
print(response.text)
elif content_type.startswith("text/") or "xml" in content_type or content_type.split(";", 1)[0].strip() in {"application/javascript", "application/x-www-form-urlencoded", "application/graphql"}:
print(response.text)
else:
with open("response.bin", "wb") as output:
output.write(response.content)
print(f"Saved {len(response.content)} bytes to response.bin")js
const BASE_URL = "https://api.justoneapi.com"; // Provided by OpenAPI servers
const url = BASE_URL + "/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE";
const response = await fetch(url, {
method: "GET",
signal: AbortSignal.timeout(120000)
});
console.log(response.status);
const responseBytes = await response.arrayBuffer();
if (responseBytes.byteLength) {
const contentType = (response.headers.get("content-type") || "").toLowerCase();
const mediaType = contentType.split(";", 1)[0].trim();
const textual = contentType.startsWith("text/") || contentType.includes("json") || contentType.includes("xml") || ["application/javascript", "application/x-www-form-urlencoded", "application/graphql"].includes(mediaType);
if (textual) {
const responseText = new TextDecoder().decode(responseBytes);
let data = responseText;
if (contentType.includes("json")) {
try { data = JSON.parse(responseText); } catch { /* Keep the raw body. */ }
}
console.log(data);
} else {
console.log(`Received ${responseBytes.byteLength} binary bytes`);
}
}java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
public class Main {
public static void main(String[] args) throws Exception {
final String BASE_URL = "https://api.justoneapi.com"; // Provided by OpenAPI servers
final String url = BASE_URL + "/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE";
HttpClient client = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(120)).build();
HttpRequest.Builder builder = HttpRequest.newBuilder()
.uri(URI.create(url))
.timeout(Duration.ofSeconds(120))
.method("GET", HttpRequest.BodyPublishers.noBody());
HttpRequest request = builder.build();
HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());
System.out.println(response.statusCode());
String contentType = response.headers().firstValue("content-type").orElse("").toLowerCase();
String mediaType = contentType.split(";", 2)[0].trim();
if (contentType.startsWith("text/") || contentType.contains("json") || contentType.contains("xml") || mediaType.equals("application/javascript") || mediaType.equals("application/x-www-form-urlencoded") || mediaType.equals("application/graphql")) {
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
} else {
Files.write(Path.of("response.bin"), response.body());
System.out.println("Saved " + response.body().length + " bytes to response.bin");
}
}
}go
package main
import (
"fmt"
"io"
"os"
"strings"
"net/http"
"time"
)
const BASE_URL = "https://api.justoneapi.com" // Provided by OpenAPI servers
func main() {
client := &http.Client{Timeout: 120 * time.Second}
url := BASE_URL + "/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE"
req, _ := http.NewRequest("GET", url, nil)
resp, _ := client.Do(req)
defer resp.Body.Close()
fmt.Println(resp.StatusCode)
bodyBytes, _ := io.ReadAll(resp.Body)
contentType := strings.ToLower(resp.Header.Get("Content-Type"))
mediaType := strings.TrimSpace(strings.SplitN(contentType, ";", 2)[0])
if strings.HasPrefix(contentType, "text/") || strings.Contains(contentType, "json") || strings.Contains(contentType, "xml") || mediaType == "application/javascript" || mediaType == "application/x-www-form-urlencoded" || mediaType == "application/graphql" {
fmt.Println(string(bodyBytes))
} else {
os.WriteFile("response.bin", bodyBytes, 0600)
fmt.Printf("Saved %d bytes to response.bin\n", len(bodyBytes))
}
}php
<?php
$BASE_URL = 'https://api.justoneapi.com'; // Provided by OpenAPI servers
$url = $BASE_URL . '/api/1688/search-cross-border-item-by-image/v1?token=YOUR_API_KEY&imgUrl=VALUE';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 120);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$contentType = strtolower((string) curl_getinfo($ch, CURLINFO_CONTENT_TYPE));
curl_close($ch);
echo $status . PHP_EOL;
$mediaType = trim(explode(';', $contentType, 2)[0]);
if (str_starts_with($contentType, 'text/') || str_contains($contentType, 'json') || str_contains($contentType, 'xml') || in_array($mediaType, ['application/javascript', 'application/x-www-form-urlencoded', 'application/graphql'], true)) {
echo $response;
} else {
file_put_contents('response.bin', $response);
echo 'Saved ' . strlen($response) . ' bytes to response.bin' . PHP_EOL;
}Response Example
Loading the response example...