Skip to content

Xiaohongshu (RedNote) Note Details API (V1) ​

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

Retrieves Xiaohongshu (RedNote) details for a note identified by a note ID or supported explore URL. Use it to perform direct note lookup and content review from stored identifiers or shared explore links.

Highlights ​

Limitation

This version does not support video downloads.

Guidance

Use v6 for video download workflows.

Parameters ​

NameInTypeRequiredDefaultDescription
tokenquerystringYes-Access token for this API service.
noteIdquerystringYes-A Xiaohongshu note ID or an explore URL containing /explore/.

Code Samples ​

bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/xiaohongshu/get-note-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/get-note-detail/v1?token=YOUR_API_KEY&noteId=VALUE
API Endpoint: BASE_URL + /api/xiaohongshu/get-note-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-rednote/note-details-v1-en.json

Parameters:
- token (query): Access token for this API service. (Required)
- noteId (query): A Xiaohongshu note ID or an explore URL containing /explore/. (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/get-note-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/get-note-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/get-note-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/get-note-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/get-note-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 information6 fields

data[].note_list[]

FieldTypeDescription
idstringXiaohongshu note ID.
titlestringNote title.
descstringText of the note.
typestringNote type reported by Xiaohongshu.
timeintegerNote publication time as a Unix timestamp in seconds.
last_update_timeintegerLast update time of the note as a Unix timestamp in seconds. Some responses return 0.
Engagement7 fields

data[].note_list[]

FieldTypeDescription
liked_countintegerNumber of likes reported for the note.
collected_countintegerNumber of saves reported for the note.
comments_countintegerNumber of comments reported for the note.
shared_countintegerNumber of shares reported for the note.
likedbooleanLike status reported by Xiaohongshu for the current response context.
collectedbooleanSave status reported by Xiaohongshu for the current response context.
liked_usersarrayList of users who liked the note. It may be empty even when the reported like count is positive.
Author22 fields

data[].note_list[].user

Author of the note.

FieldTypeDescription
idstringAuthor's Xiaohongshu user ID.
nicknamestringAuthor's display name.
imagestringURL of the author's profile image.
namestringName field supplied for the user.
useridstringUser identifier returned in the userid field.
red_idstringXiaohongshu account number returned for the user.
followedbooleanFollow status reported by Xiaohongshu for the current response context.
red_official_verifiedbooleanOfficial verification status reported by Xiaohongshu.
red_official_verify_typeintegerOfficial verification category code reported by Xiaohongshu.
show_red_official_verify_iconbooleanFlag indicating whether to display the official verification icon.
levelobjectUser level metadata reported by Xiaohongshu.
level.imagestringImage field in the user level metadata. It may be empty.
liveobjectLivestream metadata returned for the user, when available.
live.room_idstringLivestream room ID reported by Xiaohongshu.
live.user_idstringUser ID associated with the livestream.
live.live_linkstringLink supplied by Xiaohongshu for the livestream.
live.start_timeintegerLivestream start time value reported by Xiaohongshu.
live.live_statusintegerRaw livestream status code reported by Xiaohongshu.
live.has_goodsbooleanLivestream merchandise flag reported by Xiaohongshu.
live.has_red_packetbooleanLivestream red envelope flag reported by Xiaohongshu.
live.has_drawbooleanLivestream prize draw flag reported by Xiaohongshu.
live.show_lightbooleanLivestream indicator flag reported by Xiaohongshu.
Live Photos57 fields

data[].note_list[].images_list[].live_photo

Live Photo metadata returned for the image when available.

FieldTypeDescription
imageobjectImage metadata returned within the Live Photo.
image.first_framestringFirst-frame image field returned for the Live Photo. It may be empty.
mediaobjectPlayback metadata supplied for the Live Photo.
media.video_idstringVideo ID reported for the Live Photo media.
media.videoobjectVideo metadata associated with the Live Photo.
media.video.widthintegerVideo width in pixels.
media.video.heightintegerVideo height in pixels.
media.video.durationintegerVideo duration value reported for the Live Photo.
media.video.drm_typeintegerRaw DRM category code reported for the video.
media.video.hdr_typeintegerRaw HDR category code reported for the video.
media.video.stream_typesarrayStream type codes reported for the video.
media.video.stream_types[]integerRaw stream type code reported for the video.
media.streamobjectStream variants grouped by the codec labels returned by Xiaohongshu.
media.stream.h264arrayH.264 streams returned for the Live Photo.
media.stream.h264[]objectMetadata for one H.264 Live Photo stream.
media.stream.h264[].master_urlstringPrimary URL supplied for this stream.
media.stream.h264[].backup_urlsarrayAlternate URLs supplied for the stream.
media.stream.h264[].backup_urls[]stringAlternate stream URL.
media.stream.h264[].widthintegerStream width in pixels.
media.stream.h264[].heightintegerStream height in pixels.
media.stream.h264[].fpsintegerFrame rate reported for the stream.
media.stream.h264[].formatstringMedia format reported for the stream.
media.stream.h264[].video_codecstringVideo codec reported for the stream.
media.stream.h264[].audio_codecstringAudio codec reported for the stream. It may be empty.
media.stream.h264[].audio_channelsintegerNumber of audio channels reported for the stream.
media.stream.h264[].avg_bitrateintegerAverage bitrate value reported for the stream.
media.stream.h264[].video_bitrateintegerVideo bitrate value reported for the stream.
media.stream.h264[].audio_bitrateintegerAudio bitrate value reported for the stream.
media.stream.h264[].quality_typestringRaw quality label reported for the stream.
media.stream.h264[].stream_descstringDescription supplied by Xiaohongshu for the stream.
media.stream.h264[].durationintegerStream duration value reported by Xiaohongshu.
media.stream.h264[].video_durationintegerVideo duration value reported for the stream.
media.stream.h264[].audio_durationintegerAudio duration value reported for the stream.
media.stream.h264[].sizeintegerStream size value reported by Xiaohongshu.
media.stream.h265arrayH.265 streams returned for the Live Photo.
media.stream.h265[]objectMetadata for one H.265 Live Photo stream.
media.stream.h265[].master_urlstringPrimary URL supplied for this stream.
media.stream.h265[].backup_urlsarrayAlternate URLs supplied for the stream.
media.stream.h265[].backup_urls[]stringAlternate stream URL.
media.stream.h265[].widthintegerStream width in pixels.
media.stream.h265[].heightintegerStream height in pixels.
media.stream.h265[].fpsintegerFrame rate reported for the stream.
media.stream.h265[].formatstringMedia format reported for the stream.
media.stream.h265[].video_codecstringVideo codec reported for the stream.
media.stream.h265[].audio_codecstringAudio codec reported for the stream. It may be empty.
media.stream.h265[].audio_channelsintegerNumber of audio channels reported for the stream.
media.stream.h265[].avg_bitrateintegerAverage bitrate value reported for the stream.
media.stream.h265[].video_bitrateintegerVideo bitrate value reported for the stream.
media.stream.h265[].audio_bitrateintegerAudio bitrate value reported for the stream.
media.stream.h265[].quality_typestringRaw quality label reported for the stream.
media.stream.h265[].stream_descstringDescription supplied by Xiaohongshu for the stream.
media.stream.h265[].durationintegerStream duration value reported by Xiaohongshu.
media.stream.h265[].video_durationintegerVideo duration value reported for the stream.
media.stream.h265[].audio_durationintegerAudio duration value reported for the stream.
media.stream.h265[].sizeintegerStream size value reported by Xiaohongshu.
media.stream.h266arrayH.266 stream list returned by Xiaohongshu. It may be empty.
media.stream.av1arrayAV1 stream list returned by Xiaohongshu. It may be empty.
Images27 fields

data[].note_list[].images_list[]

Images associated with the note, which may include cover images for video notes.

FieldTypeDescription
urlstringImage URL.
originalstringURL supplied in the original-image field.
widthintegerImage width in pixels.
heightintegerImage height in pixels.
fileidstringPlatform file identifier for the image.
indexintegerImage position index reported by the platform.
need_load_original_imagebooleanPlatform flag for loading the original image.
origin_imgobjectOriginal-image metadata supplied by Xiaohongshu.
origin_img.widthintegerOriginal image width in pixels. Some responses return 0.
origin_img.heightintegerOriginal image height in pixels. Some responses return 0.
origin_img.sizenumberOriginal-image size value reported by Xiaohongshu.
url_multi_levelobjectImage URLs grouped by levels reported by the platform. URLs may repeat across levels.
url_multi_level.lowstringURL reported for the low image level.
url_multi_level.mediumstringURL reported for the medium image level.
url_multi_level.highstringURL reported for the high image level.
url_size_largestringURL supplied for the large-size image variant.
url_8kstringURL supplied for the 8K image variant.
filterobjectFilter metadata associated with the image.
filter.filter_idstringFilter ID reported by Xiaohongshu.
filter.user_idstringUser ID returned in this filter entry.
filter.creator_nicknamestringDisplay name supplied for the filter creator.
filter.filter_urlstringURL supplied for the filter.
filter.special_effect_imagestringImage supplied for the filter effect.
filter.filter_entrance_namestringDisplay label for the filter entry point.
filter.show_filter_entrancebooleanFlag for displaying this filter entry point.
filter.linkstringLink associated with the filter.
live_photo_file_idstringFile ID reported for the image’s Live Photo.
Video13 fields

data[].note_list[].video

Video metadata that may be returned for some notes. Use V6 for video downloads.

FieldTypeDescription
idstringVideo ID reported for the note.
widthintegerVideo width in pixels.
heightintegerVideo height in pixels.
durationintegerVideo duration value reported by Xiaohongshu.
thumbnailstringURL supplied for the video thumbnail.
first_framestringURL supplied for the first frame of the video.
urlstringMedia URL supplied by Xiaohongshu for the video.
url_info_listarrayMedia variants returned for the video.
url_info_list[]objectMetadata for a returned video variant.
url_info_list[].widthintegerVideo variant width in pixels.
url_info_list[].heightintegerVideo variant height in pixels.
url_info_list[].descstringDescription supplied for the video variant.
url_info_list[].urlstringMedia URL supplied for the video variant.
Topics16 fields

data[].note_list[]

FieldTypeDescription
hash_tagarrayHashtags attached to the note.
hash_tag[]object-
hash_tag[].idstringHashtag ID.
hash_tag[].namestringHashtag name.
hash_tag[].linkstringLink to the hashtag, which may use the Xiaohongshu app link scheme.
hash_tag[].typestringHashtag type code reported by the platform.
topicsarrayTopic entries attached to the note. Entries may overlap with hashtags.
topics[]object-
topics[].idstringXiaohongshu topic ID.
topics[].namestringName of the topic.
topics[].linkstringLink to the topic, which may use the Xiaohongshu app link scheme.
topics[].imagestringURL of the topic image.
topics[].discuss_numintegerDiscussion count reported for this topic.
topics[].activity_onlinebooleanOnline status flag for the topic activity.
topics[].styleintegerStyle code reported for the topic.
topics[].business_typeintegerBusiness category code reported for the topic.
Sharing19 fields

data[].note_list[]

FieldTypeDescription
share_infoobjectSharing information associated with the note.
share_info.linkstringShare URL for the Xiaohongshu note.
share_info.titlestringTitle used in the share preview.
share_info.contentstringBody text supplied for sharing the note.
share_info.imagestringImage URL supplied for the share preview.
share_info.wechat_share_descstringDescription supplied for sharing on WeChat.
share_info.show_wechat_tagbooleanFlag for displaying the WeChat label in the sharing configuration.
share_info.block_private_msgbooleanPrivate-message restriction flag in the sharing configuration.
share_info.function_entriesarraySharing action entries supplied by the platform.
share_info.function_entries[]object-
share_info.function_entries[].typestringType code of the sharing action entry.
long_press_share_infoobjectSharing information associated with the long-press menu.
long_press_share_info.titlestringShare title supplied for the long-press menu.
long_press_share_info.contentstringShare body text supplied for the long-press menu.
long_press_share_info.show_wechat_tagbooleanFlag for displaying the WeChat label in the sharing configuration.
long_press_share_info.block_private_msgbooleanPrivate-message restriction flag in the sharing configuration.
long_press_share_info.function_entriesarraySharing action entries supplied by the platform.
long_press_share_info.function_entries[]object-
long_press_share_info.function_entries[].typestringType code of the sharing action entry.
Audio10 fields

data[].note_list[].native_voice_info

Voice and audio metadata attached to the note.

FieldTypeDescription
sound_idstringPlatform identifier of the audio item.
namestringName of the audio item.
descstringDescription supplied for the audio item.
subtitlestringSubtitle text supplied for the audio item.
coverstringCover image URL of the audio item.
urlstringAudio file URL.
md5sumstringMD5 checksum of the audio file supplied in this entry.
use_countintegerUsage count reported for the audio item.
sound_bg_music_typeintegerPlatform category code for the audio background music.
durationintegerAudio duration in milliseconds.
Mini programs16 fields

data[].note_list[]

FieldTypeDescription
mini_program_infoobjectMini-program linking and sharing metadata for the note.
mini_program_info.titlestringMini-program title supplied with the note.
mini_program_info.descstringMini-program description supplied with the note.
mini_program_info.pathstringPath to the page inside the mini-program.
mini_program_info.share_titlestringTitle used to share the mini-program.
mini_program_info.thumbstringMini-program thumbnail URL.
mini_program_info.user_namestringAccount name reported for the mini-program.
mini_program_info.webpage_urlstringWeb page URL supplied for the mini-program.
qq_mini_program_infoobjectQQ mini-program linking and sharing metadata for the note.
qq_mini_program_info.titlestringMini-program title supplied with the note.
qq_mini_program_info.descstringMini-program description supplied with the note.
qq_mini_program_info.pathstringPath to the page inside the mini-program.
qq_mini_program_info.share_titlestringTitle used to share the mini-program.
qq_mini_program_info.thumbstringMini-program thumbnail URL.
qq_mini_program_info.user_namestringAccount name reported for the mini-program.
qq_mini_program_info.webpage_urlstringWeb page URL supplied for the mini-program.
Mentions and relationships21 fields

data[].note_list[]

FieldTypeDescription
atsarrayUser profiles mentioned in the note.
ats[]objectUser profile returned for a mention.
ats[].idstringXiaohongshu user ID of the mentioned account.
ats[].namestringName field supplied for the user.
ats[].nicknamestringAuthor's display name.
ats[].followedbooleanFollow status reported by Xiaohongshu for the current response context.
ats[].red_official_verifiedbooleanOfficial verification status reported by Xiaohongshu.
ats[].red_official_verify_typeintegerOfficial verification category code reported by Xiaohongshu.
ats[].show_red_official_verify_iconbooleanFlag indicating whether to display the official verification icon.
ats[].levelobjectUser level metadata reported by Xiaohongshu.
ats[].level.imagestringImage field in the user level metadata. It may be empty.
co_produce_linkstringLink supplied by Xiaohongshu for co-creation.
note_statementobjectStatement metadata associated with the note.
note_statement.show_textstringStatement text supplied for display with the note.
note_statement.pop_textstringStatement text supplied for the popup.
note_statement.origin_infoobjectSource attribution metadata supplied for the note.
note_statement.origin_info.origin_linkstringLink associated with the source attribution.
note_statement.origin_info.origin_textstringText associated with the source attribution.
order_cooperateobjectCooperation order metadata reported by Xiaohongshu.
order_cooperate.statusintegerRaw cooperation order status code reported by Xiaohongshu.
user_idstringUser ID returned directly on the note record, when supplied.
Note status and content13 fields

data[].note_list[]

FieldTypeDescription
model_typestringNote model type reported by Xiaohongshu.
stickybooleanPinned status reported for the note.
text_language_codestringLanguage code reported for the note text.
ip_locationstringIP location label supplied by Xiaohongshu for this note.
has_musicbooleanMusic association flag reported by Xiaohongshu for the note.
has_related_goodsbooleanFlag indicating whether the note has associated products.
has_co_producebooleanFlag indicating whether the note is associated with co-creation.
enable_co_producebooleanPlatform switch for the co-creation feature.
enable_brand_lotterybooleanPlatform switch for the brand giveaway feature.
red_envelope_notebooleanFlag indicating whether the platform marks this as a red envelope note.
may_have_red_packetbooleanFlag indicating that a red envelope may be associated with the note.
note_attributesarrayNote attributes reported by Xiaohongshu.
note_attributes[]stringRaw note attribute value returned by Xiaohongshu.
Feature and visibility settings21 fields

data[].note_list[]

FieldTypeDescription
comment_prompt_configobjectComment entry prompts and restriction configuration.
comment_prompt_config.placeholder_shortstringShort placeholder text for comment input.
comment_prompt_config.placeholder_longstringLong placeholder text for comment input.
comment_prompt_config.forbidden_cmt_typeintegerComment restriction type code reported by the platform.
function_switcharrayFeature switches supplied by the platform for the note.
function_switch[]object-
function_switch[].typestringFeature type code for the switch.
function_switch[].enablebooleanWhether the platform marks the feature as enabled.
function_switch[].reasonstringReason supplied for the feature switch, when available.
media_save_configobjectMedia saving configuration supplied by the platform.
media_save_config.disable_savebooleanPlatform flag for disabling media saving.
media_save_config.disable_watermarkbooleanPlatform flag for disabling watermarks in the media saving configuration.
media_save_config.disable_weibo_coverbooleanPlatform flag for disabling the Weibo cover in the media saving configuration.
privacyobjectVisibility and privacy metadata reported by Xiaohongshu for the current response context.
privacy.typeintegerRaw visibility category code reported by Xiaohongshu.
privacy.show_tipsbooleanFlag for displaying a privacy-related tip.
feedback_infoobjectFeedback information returned for the note.
feedback_info.dislike_statusintegerPlatform status code for dislike feedback.
note_text_press_optionsarrayMenu options associated with a long press on note text.
note_text_press_options[]object-
note_text_press_options[].keystringPlatform key of the long-press menu option.
Response context27 fields

data[]

FieldTypeDescription
note_listarrayNotes in this result.
model_typestringResult model type reported by Xiaohongshu.
userobjectUser profile attached to this result.
user.idstringXiaohongshu user ID.
user.nicknamestringUser display name.
user.imagestringURL of the user's profile image.
user.namestringName field supplied for the user.
user.useridstringUser identifier returned in the userid field.
user.red_idstringXiaohongshu account number returned for the user.
user.followedbooleanFollow status reported by Xiaohongshu for the current response context.
user.red_official_verifiedbooleanOfficial verification status reported by Xiaohongshu.
user.red_official_verify_typeintegerOfficial verification category code reported by Xiaohongshu.
user.show_red_official_verify_iconbooleanFlag indicating whether to display the official verification icon.
user.levelobjectUser level metadata reported by Xiaohongshu.
user.level.imagestringImage field in the user level metadata. It may be empty.
user.liveobjectLivestream metadata returned for the user, when available.
user.live.room_idstringLivestream room ID reported by Xiaohongshu.
user.live.user_idstringUser ID associated with the livestream.
user.live.live_linkstringLink supplied by Xiaohongshu for the livestream.
user.live.start_timeintegerLivestream start time value reported by Xiaohongshu.
user.live.live_statusintegerRaw livestream status code reported by Xiaohongshu.
user.live.has_goodsbooleanLivestream merchandise flag reported by Xiaohongshu.
user.live.has_red_packetbooleanLivestream red envelope flag reported by Xiaohongshu.
user.live.has_drawbooleanLivestream prize draw flag reported by Xiaohongshu.
user.live.show_lightbooleanLivestream indicator flag reported by Xiaohongshu.
comment_listarrayComment list attached to the detail result. It may be empty even when the reported comment count is positive.
track_idstringOpaque tracking ID returned with the result, which may be empty.

Response Example ​

Loading the response example...