Xiaohongshu Pgy APIs - KOL Note Rate (V1)

DEPRECATED

This endpoint is deprecated and may be removed in future versions.

prod-global

GET

/api/xiaohongshu-pgy/get-kol-note-rate/v1

Get note performance rate (Legacy).

Parameters

Name	In	Type	Required	Description
`token`	query	`string`	Yes	User authentication token.
`kolId`	query	`string`	Yes	KOL ID.
`dateType`	query	`string`	No	Date type. Available Values: - `_1`: Last 30 days - `_2`: Last 90 days
`noteType`	query	`string`	No	Note type. Available Values: - `_1`: Photo and Text - `_2`: Video - `_3`: Photo and Video
`adSwitch`	query	`string`	No	Ad filter. Available Values: - `_1`: Full traffic (All notes) - `_0`: Natural traffic (Organic notes)
`business`	query	`string`	No	Business type. Available Values: - `_0`: Normal notes - `_1`: Cooperation notes
`acceptCache`	query	`boolean`	No	Enable cache.

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.

bash

# 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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=VALUE"

text

I want to use the "KOL Note Rate (V1) [Deprecated]" API from Just One API.
API Endpoint: https://api.justoneapi.com/api/xiaohongshu-pgy/get-kol-note-rate/v1
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xiaohongshu-pgy-apis/kol-note-rate-v1-deprecated-en.json

Parameters:
- token (query): User authentication token. (Required)
- kolId (query): KOL ID. (Required)
- dateType (query): Date type.

Available Values:
- `_1`: Last 30 days
- `_2`: Last 90 days
- noteType (query): Note type.

Available Values:
- `_1`: Photo and Text
- `_2`: Video
- `_3`: Photo and Video
- adSwitch (query): Ad filter.

Available Values:
- `_1`: Full traffic (All notes)
- `_0`: Natural traffic (Organic notes)
- business (query): Business type.

Available Values:
- `_0`: Normal notes
- `_1`: Cooperation notes
- acceptCache (query): Enable cache.

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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=VALUE"
response = requests.get(url)
print(response.json())

// 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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=VALUE"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

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

// 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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=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/get-kol-note-rate/v1?token=YOUR_API_KEY&kolId=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

json

{
  "code": 0,
  "data": {
    "noteNumber": 0,
    "videoNoteNumber": 0,
    "hundredLikePercent": "0.0",
    "thousandLikePercent": "0.0",
    "noteType": [],
    "tradeNames": null,
    "impMedian": 0,
    "impMedianBeyondRate": "0.0",
    "readMedian": 0,
    "readMedianBeyondRate": "0.0",
    "interactionMedian": 0,
    "interactionRate": "0.0",
    "interactionBeyondRate": "0.0",
    "likeMedian": 0,
    "collectMedian": 0,
    "commentMedian": 0,
    "shareMedian": 0,
    "videoFullViewRate": "0.0",
    "videoFullViewBeyondRate": "0.0",
    "picture3sViewRate": "0.0",
    "notes": null,
    "pagePercentVo": null,
    "longTermCommonNoteVo": {
      "startPublishTime": "2025-07-12",
      "endPublishTime": "2025-09-10",
      "noteNumber": 0,
      "recentReadNum": null,
      "recentReadBeyondRate": null,
      "longTermReadNum": null,
      "longTermReadBeyondRate": null,
      "recentSearchPagePercent": null,
      "recentFindPagePercent": null,
      "recentKolHomePagePercent": null,
      "recentFollowPagePercent": null,
      "recentOtherPagePercent": null,
      "longTermSearchPagePercent": null,
      "longTermFindPagePercent": null,
      "longTermKolHomePagePercent": null,
      "longTermFollowPagePercent": null,
      "longTermOtherPagePercent": null
    },
    "longTermCooperateNoteVo": {
      "startPublishTime": "2025-07-12",
      "endPublishTime": "2025-09-10",
      "noteNumber": 0,
      "recentReadNum": null,
      "recentReadBeyondRate": null,
      "longTermReadNum": null,
      "longTermReadBeyondRate": null,
      "recentSearchPagePercent": null,
      "recentFindPagePercent": null,
      "recentKolHomePagePercent": null,
      "recentFollowPagePercent": null,
      "recentOtherPagePercent": null,
      "longTermSearchPagePercent": null,
      "longTermFindPagePercent": null,
      "longTermKolHomePagePercent": null,
      "longTermFollowPagePercent": null,
      "longTermOtherPagePercent": null
    },
    "mengagementNum": 0,
    "mfollowCnt": 0,
    "mEngagementNum": 0,
    "mFollowCnt": 0
  }
}

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

Xiaohongshu Pgy APIs - KOL Note Rate (V1) ​

Parameters ​

Code Samples ​

Responses ​

Xiaohongshu Pgy APIs - KOL Note Rate (V1)

Parameters

Code Samples

Responses