Skip to content

Xiaohongshu Creator Marketplace (Pugongying) Note Details API (V1) ​

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

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 ​

NameInTypeRequiredDefaultDescription
tokenquerystringYes-User authentication token.
noteIdquerystringYes-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&noteId=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&noteId=VALUE
API Endpoint: BASE_URL + /api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1?token=YOUR_API_KEY&noteId=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&noteId=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&noteId=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&noteId=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&noteId=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&noteId=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

FieldTypeDescription
noteIdstringThe unique Xiaohongshu note ID.
noteLinkstringThe Xiaohongshu link to the note, including any platform access parameters returned with it.
userIdstringThe Xiaohongshu user ID of the note author.
headPhotostring | nullThe note author's avatar URL, when available.
namestring | nullThe note author's display name, when available.
typeintegerThe note type code. Observed codes are 1 for image and text and 2 for video.
titlestringThe note title, which may be empty.
contentstringThe note text, including mentions or topic markup when present.
timeobjectTimestamps associated with the note.
time.createTimeintegerThe note creation time as a Unix timestamp in milliseconds.
time.updateTimeintegerThe note update time as a Unix timestamp in milliseconds.
time.userUpdateTimeintegerThe user update time field supplied with the note, as a Unix timestamp in milliseconds.
createTimestringThe note creation time formatted for display in China Standard Time.
goodCaseCollectbooleanWhether the marketplace marks the note as saved in its example collection.
Reach and engagement7 fields

data

FieldTypeDescription
impNumintegerThe note impression count reported by Pugongying.
likeNumintegerThe note like count reported by Pugongying.
favNumintegerThe note favorite count reported by Pugongying.
cmtNumintegerThe note comment count reported by Pugongying.
readNumintegerThe note read count reported by Pugongying. Metric availability can vary by note.
shareNumintegerThe note share count reported by Pugongying.
followCntintegerThe 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.

FieldTypeDescription
fileIdstringThe platform file ID of this image.
urlstringThe image URL returned for display.
originalstringThe original image URL provided by the platform.
widthintegerThe image width reported by the platform, in pixels.
heightintegerThe image height reported by the platform, in pixels.
traceIdstringThe platform trace identifier attached to the image.
imageExtraInfoobject | nullAdditional image metadata, when available.
imageExtraInfo.imageMetadatastringImage metadata returned by the platform as a string.
Video20 fields

data.videoInfo

Video information when available. Image and text notes may return null.

FieldTypeDescription
idstringThe ID of the video record.
videoKeystringThe platform storage key for the video.
originVideoKeystringThe platform storage key for the source video.
metaobjectMetadata for the video asset.
meta.widthintegerVideo width reported by the platform, in pixels.
meta.heightintegerVideo height reported by the platform, in pixels.
meta.durationintegerThe video duration in whole seconds as reported by the platform.
meta.videoIdstringVideo identifier in the asset metadata.
gifKeystringThe platform storage key for the GIF preview, when available.
videoUrlstringThe video URL supplied by the platform. It can be empty.
gifUrlstringThe URL of the GIF preview, when available.
videoKeyListarrayAdditional video asset keys when returned. The array can be empty.
hasFragmentsbooleanWhether the platform indicates that the video has fragments.
thumbnailstringThe video thumbnail URL supplied by the platform.
firstFramestring | nullThe first-frame image reference, when available.
volumenumberThe volume value reported for the video.
chaptersarray | nullChapter markers, when available.
chapters[]objectA video chapter marker.
chapters[].textstringThe chapter label.
chapters[].timeintegerThe chapter start offset from the beginning of the video, in milliseconds.
Collaboration and quotes6 fields

data.userInfo

FieldTypeDescription
cooperTypeintegerThe marketplace cooperation type code for the creator.
priceStateinteger | nullThe marketplace status code for the creator's pricing, when available.
pictureStateinteger | nullThe marketplace status code for the creator's image and text offering, when available.
picturePricenumber | nullThe marketplace quote for the creator's image and text offering, when available.
videoStateinteger | nullThe marketplace status code for the creator's video offering, when available.
videoPricenumber | nullThe marketplace quote for the creator's video offering, when available.
Creator profile23 fields

data.userInfo

Author details from the creator marketplace.

FieldTypeDescription
nickNamestringThe creator's display name in the marketplace.
avatarstringThe creator's avatar URL.
userIdstringThe creator's Xiaohongshu user ID.
fansNumintegerThe creator's follower count reported by the marketplace.
userTypeintegerThe creator account type code reported by the marketplace.
operateStateinteger | nullThe creator's marketplace operating status code, when available.
currentLevelinteger | nullThe creator level code reported by the marketplace, when available.
locationstringThe creator location label shown in the marketplace.
contentTagsarrayContent categories assigned to the creator.
contentTags[]objectA creator content category and its subcategories.
contentTags[].taxonomy1TagstringThe top-level content category label.
contentTags[].taxonomy2TagsarrayThe subcategory labels under the top-level category.
contentTags[].taxonomy2Tags[]stringA content subcategory label.
featureTagsarray | nullCreator feature tags, when available. The array can be empty.
personalTagsarray | nullCreator profile tags, when available.
personalTags[]stringA creator profile tag.
genderstringThe gender label reported in the creator profile.
isCollectbooleanWhether Pugongying marks the creator as saved.
clickMidNumintegerThe creator-level click median reported by the marketplace.
interMidNumintegerThe creator-level interaction median reported by the marketplace.
kolTypeinteger | nullThe creator category code used by the marketplace, when available.
mengagementNumintegerA creator engagement metric reported by the marketplace.
mEngagementNumintegerThe creator engagement median reported by the marketplace.

Response Example ​

Loading the response example...