Xiaohongshu Creator Marketplace (Pugongying) Creator Core Metrics API (V1)

GET

/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1

API health status

Healthy Available Limited Mostly unavailable No data

Loading health status...

Get Xiaohongshu Creator Marketplace (Pugongying) creator Core Metrics data, including engagement and content metrics, for benchmarking, vetting, and campaign planning.

Parameters

Name	In	Type	Required	Default	Description
token	query	string	Yes	-	User authentication token.
userId	query	string	Yes	-	KOL's user ID.
business	query	string	No	DAILY_NOTE	Business type. Available Values: - DAILY_NOTE: Daily notes - COOPERATE_NOTE: Cooperative notes
noteType	query	string	No	PHOTO_TEXT_AND_VIDEO	Type of note. Available Values: - PHOTO_TEXT_AND_VIDEO: Photo and Video - PHOTO_TEXT: Photo and Text - VIDEO: Video only
dateType	query	string	No	DAY_30	Time range for data. Available Values: - DAY_30: Last 30 days - DAY_90: Last 90 days
advertiseSwitch	query	string	No	ALL	Advertisement filter. Available Values: - ALL: All notes - ORGANIC_ONLY: Organic notes only

Code Samples

💡 Environment Note

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

🐚 cURL

curl -X GET "https://api.justoneapi.com/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=VALUE"

🤖 AI Prompt

I want to use the "Creator Core Metrics (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/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=VALUE
API Endpoint: BASE_URL + /api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=VALUE
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/creator-core-metrics-v1-en.json

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

Available Values:
- `DAILY_NOTE`: Daily notes
- `COOPERATE_NOTE`: Cooperative notes
- noteType (query): Type of note.

Available Values:
- `PHOTO_TEXT_AND_VIDEO`: Photo and Video
- `PHOTO_TEXT`: Photo and Text
- `VIDEO`: Video only
- dateType (query): Time range for data.

Available Values:
- `DAY_30`: Last 30 days
- `DAY_90`: Last 90 days
- advertiseSwitch (query): Advertisement filter.

Available Values:
- `ALL`: All notes
- `ORGANIC_ONLY`: Organic notes only

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

import requests

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

url = BASE_URL + "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=VALUE"
response = requests.get(url)
print(response.json())

🌐 JavaScript

const BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
const url = BASE_URL + "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=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/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=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/xiaohongshu-pgy/api/pgy/kol/data/core_data/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

<?php
$BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
$url = $BASE_URL . "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1?token=YOUR_API_KEY&userId=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;

[OpenAPI Definition (JSON)]

Response Example

Loading the latest successful example...