Xiaohongshu Creator Marketplace (Pugongying) Note Details API (V1)
GET
API health status
24h health
24h avg latency
Last checked
Healthy Available Limited Mostly unavailable No data
Healthy
Loading health status...
24h trend
30d trend
Retrieves Xiaohongshu Pugongying details for a known note ID. Use it to review an individual note during creator or campaign research.
Highlights
Capability
This endpoint can retrieve note view counts.
Condition
Engagement metrics may be unavailable for some notes.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
token | query | string | Yes | - | User authentication token. |
noteId | query | string | Yes | - | Note's unique ID. |
Code Samples
bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=VALUE'text
I want to use the "Note Details (V1)" API from JustOneAPI.
Base URL: https://api.justoneapi.com.
API Path: /api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=VALUE
API Endpoint: BASE_URL + /api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/note-details-v1-en.json
Parameters:
- token (query): User authentication token. (Required)
- noteId (query): Note's unique ID. (Required)
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/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=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/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=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/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=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/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=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/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY¬eId=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 Fields
Key fields in a successful response (code = 0).
Note information14 fields
data
| Field | Type | Description |
|---|---|---|
noteId | string | The unique Xiaohongshu note ID. |
noteLink | string | The Xiaohongshu link to the note, including any platform access parameters returned with it. |
userId | string | The Xiaohongshu user ID of the note author. |
headPhoto | string | null | The note author's avatar URL, when available. |
name | string | null | The note author's display name, when available. |
type | integer | The note type code. Observed codes are 1 for image and text and 2 for video. |
title | string | The note title, which may be empty. |
content | string | The note text, including mentions or topic markup when present. |
time | object | Timestamps associated with the note. |
time.createTime | integer | The note creation time as a Unix timestamp in milliseconds. |
time.updateTime | integer | The note update time as a Unix timestamp in milliseconds. |
time.userUpdateTime | integer | The user update time field supplied with the note, as a Unix timestamp in milliseconds. |
createTime | string | The note creation time formatted for display in China Standard Time. |
goodCaseCollect | boolean | Whether the marketplace marks the note as saved in its example collection. |
Reach and engagement7 fields
data
| Field | Type | Description |
|---|---|---|
impNum | integer | The note impression count reported by Pugongying. |
likeNum | integer | The note like count reported by Pugongying. |
favNum | integer | The note favorite count reported by Pugongying. |
cmtNum | integer | The note comment count reported by Pugongying. |
readNum | integer | The note read count reported by Pugongying. Metric availability can vary by note. |
shareNum | integer | The note share count reported by Pugongying. |
followCnt | integer | The follow count reported alongside the note's metrics. The attribution window is unspecified. |
Images8 fields
data.imagesList[]
Images associated with the note, including a cover image when present.
| Field | Type | Description |
|---|---|---|
fileId | string | The platform file ID of this image. |
url | string | The image URL returned for display. |
original | string | The original image URL provided by the platform. |
width | integer | The image width reported by the platform, in pixels. |
height | integer | The image height reported by the platform, in pixels. |
traceId | string | The platform trace identifier attached to the image. |
imageExtraInfo | object | null | Additional image metadata, when available. |
imageExtraInfo.imageMetadata | string | Image metadata returned by the platform as a string. |
Video20 fields
data.videoInfo
Video information when available. Image and text notes may return null.
| Field | Type | Description |
|---|---|---|
id | string | The ID of the video record. |
videoKey | string | The platform storage key for the video. |
originVideoKey | string | The platform storage key for the source video. |
meta | object | Metadata for the video asset. |
meta.width | integer | Video width reported by the platform, in pixels. |
meta.height | integer | Video height reported by the platform, in pixels. |
meta.duration | integer | The video duration in whole seconds as reported by the platform. |
meta.videoId | string | Video identifier in the asset metadata. |
gifKey | string | The platform storage key for the GIF preview, when available. |
videoUrl | string | The video URL supplied by the platform. It can be empty. |
gifUrl | string | The URL of the GIF preview, when available. |
videoKeyList | array | Additional video asset keys when returned. The array can be empty. |
hasFragments | boolean | Whether the platform indicates that the video has fragments. |
thumbnail | string | The video thumbnail URL supplied by the platform. |
firstFrame | string | null | The first-frame image reference, when available. |
volume | number | The volume value reported for the video. |
chapters | array | null | Chapter markers, when available. |
chapters[] | object | A video chapter marker. |
chapters[].text | string | The chapter label. |
chapters[].time | integer | The chapter start offset from the beginning of the video, in milliseconds. |
Collaboration and quotes6 fields
data.userInfo
| Field | Type | Description |
|---|---|---|
cooperType | integer | The marketplace cooperation type code for the creator. |
priceState | integer | null | The marketplace status code for the creator's pricing, when available. |
pictureState | integer | null | The marketplace status code for the creator's image and text offering, when available. |
picturePrice | number | null | The marketplace quote for the creator's image and text offering, when available. |
videoState | integer | null | The marketplace status code for the creator's video offering, when available. |
videoPrice | number | null | The marketplace quote for the creator's video offering, when available. |
Creator profile23 fields
data.userInfo
Author details from the creator marketplace.
| Field | Type | Description |
|---|---|---|
nickName | string | The creator's display name in the marketplace. |
avatar | string | The creator's avatar URL. |
userId | string | The creator's Xiaohongshu user ID. |
fansNum | integer | The creator's follower count reported by the marketplace. |
userType | integer | The creator account type code reported by the marketplace. |
operateState | integer | null | The creator's marketplace operating status code, when available. |
currentLevel | integer | null | The creator level code reported by the marketplace, when available. |
location | string | The creator location label shown in the marketplace. |
contentTags | array | Content categories assigned to the creator. |
contentTags[] | object | A creator content category and its subcategories. |
contentTags[].taxonomy1Tag | string | The top-level content category label. |
contentTags[].taxonomy2Tags | array | The subcategory labels under the top-level category. |
contentTags[].taxonomy2Tags[] | string | A content subcategory label. |
featureTags | array | null | Creator feature tags, when available. The array can be empty. |
personalTags | array | null | Creator profile tags, when available. |
personalTags[] | string | A creator profile tag. |
gender | string | The gender label reported in the creator profile. |
isCollect | boolean | Whether Pugongying marks the creator as saved. |
clickMidNum | integer | The creator-level click median reported by the marketplace. |
interMidNum | integer | The creator-level interaction median reported by the marketplace. |
kolType | integer | null | The creator category code used by the marketplace, when available. |
mengagementNum | integer | A creator engagement metric reported by the marketplace. |
mEngagementNum | integer | The creator engagement median reported by the marketplace. |
Response Example
Loading the response example...