Xiaohongshu Pgy APIs - Cost Effective (V1)

prod-global

GET

/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1

Analyze cost-effectiveness of a specific KOL.

Parameters

Name	In	Type	Required	Description
token	query	string	Yes	User authentication token.
userId	query	string	Yes	KOL's user ID.

Code Samples

💡 Environment Note

Default samples use https://api.justoneapi.com (prod-global). For users in Mainland China, it is recommended to replace it with http://47.117.133.51:30015 (prod-cn) for better performance. See Environment Guide.

🐚 cURL

# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
curl -X GET "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=VALUE"

🤖 AI Prompt

I want to use the "Cost Effective (V1)" API from Just One API.
API Endpoint: https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xiaohongshu-pgy-apis/cost-effective-v1-en.json

Parameters:
- token (query): User authentication token. (Required)
- userId (query): KOL's user ID. (Required)

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 request timeout to at least 60 seconds.
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

# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
import requests

url = "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=VALUE"
response = requests.get(url)
print(response.json())

🌐 JavaScript

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
const response = await fetch("https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=VALUE", {
  method: "GET"
});
const data = await response.json();
console.log(data);

☕ Java

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
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 {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=VALUE"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

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

🐹 Go

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
package main

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

func main() {
	client := &http.Client{}
	url := "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=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

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1?token=YOUR_API_KEY&userId=VALUE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;

[OpenAPI Definition (JSON)]

Responses

{
  "code": 0,
  "data": {
    "date": null,
    "pictureReadCost": null,
    "videoReadCost": "1.78",
    "pictureSurpassRate": null,
    "videoSurpassRate": 66.53,
    "pictureCase": 2,
    "videoCase": 0,
    "estimatePictureCpm": null,
    "estimatePictureCpmCompare": null,
    "estimateVideoCpm": 227.75008224308527,
    "estimateVideoCpmCompare": 0.35473289597000934,
    "estimatePictureEngageCost": null,
    "estimatePictureEngageCostCompare": null,
    "estimateVideoEngageCost": 24.128686327077748,
    "estimateVideoEngageCostCompare": 0.24320524835988755
  }
}

💡 Note: For list data, the example shows only 1-2 items for simplicity. The actual count depends on the API response.