Skip to content

Xianyu (GooFish) Product Search API (V1)

GET
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...

Get Xianyu (GooFish) product Search data by keyword, including matched second-hand marketplace listings, seller signals, prices, images, filters, and pagination metadata, for resale-market discovery, catalog research, pricing analysis, and item monitoring.

Parameters

NameInTypeRequiredDefaultDescription
tokenquerystringYes-Access token for this API service.
keywordquerystringYes-Search keyword.
pagequerystringNo-Page number for pagination. The first page is 1.
sortquerystringNoactiveSort order for Xianyu search results.

Available Values:
- active: Active listings first.
- recent: Recent nearby or position-based results first.
- credit: Seller credit first.
- price_asc: Lowest price first.
- price_desc: Highest price first.
- price_drop: Reduced-price listings first.
- newest: Newly listed items first.

Code Samples

💡 Environment Note

Use https://api.justoneapi.com by default. Mainland China users can use http://47.117.133.51:30015 instead.

bash
curl -X GET "https://api.justoneapi.com/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE"
text
I want to use the "Product Search (V1)" API from Just One API.
Base URL: use https://api.justoneapi.com by default. Mainland China users can use http://47.117.133.51:30015 instead.
API Path: /api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE
API Endpoint: BASE_URL + /api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xianyu-goofish/product-search-v1-en.json

Parameters:
- token (query): Access token for this API service. (Required)
- keyword (query): Search keyword. (Required)
- page (query): Page number for pagination. The first page is 1.
- sort (query): Sort order for Xianyu search results.

Available Values:
- `active`: Active listings first.
- `recent`: Recent nearby or position-based results first.
- `credit`: Seller credit first.
- `price_asc`: Lowest price first.
- `price_desc`: Highest price first.
- `price_drop`: Reduced-price listings first.
- `newest`: Newly listed items first.

Return format: JSON

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

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"  # Mainland China: "http://47.117.133.51:30015"

url = BASE_URL + "/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE"
response = requests.get(url)
print(response.json())
js
const BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
const url = BASE_URL + "/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE";

const response = await fetch(url, {
  method: "GET"
});
const data = await response.json();
console.log(data);
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        final String BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
        final String url = BASE_URL + "/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

const BASE_URL = "https://api.justoneapi.com" // Mainland China: "http://47.117.133.51:30015"

func main() {
	client := &http.Client{}
	url := BASE_URL + "/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE"
	req, _ := http.NewRequest("GET", url, nil)
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}
php
<?php
$BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
$url = $BASE_URL . "/api/xianyu/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Response Example

Loading the latest successful example...