Skip to content

Xiaohongshu (RedNote) Note Details API (V6) ​

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

Retrieves Xiaohongshu (RedNote) video-note details by note ID. Use it to look up and process a known video note.

Highlights ​

Condition

This endpoint supports video downloads for video notes only; image-and-text notes are not supported.

Parameters ​

NameInTypeRequiredDefaultDescription
tokenquerystringYes-Access token for this API service.
noteIdquerystringYes-Unique note identifier on Xiaohongshu.

Code Samples ​

bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/xiaohongshu/get-note-detail/v6?token=YOUR_API_KEY&noteId=VALUE'
text
I want to use the "Note Details (V6)" API from JustOneAPI.
Base URL: https://api.justoneapi.com.
API Path: /api/xiaohongshu/get-note-detail/v6?token=YOUR_API_KEY&noteId=VALUE
API Endpoint: BASE_URL + /api/xiaohongshu/get-note-detail/v6?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-v6-en.json

Parameters:
- token (query): Access token for this API service. (Required)
- noteId (query): Unique note identifier on Xiaohongshu. (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/v6?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/v6?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/v6?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/v6?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/v6?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).

Video note information8 fields

data[]

Video-note details. A successful response usually returns an array with the matching note or an empty array.

FieldTypeDescription
idstringXiaohongshu note ID.
typestringNote type label returned for this video note.
titlestringNote title.
descstringNote description text.
timeintegerNote publication time as a Unix timestamp in seconds.
last_update_timeintegerLast update time as a Unix timestamp in seconds when set. The value can be zero.
text_language_codestringText language code reported for the note.
ip_locationstringLocation label shown on the note by the platform.
Engagement7 fields

data[]

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.
view_countintegerNumber of views reported for the note.
likedbooleanLike status reported with the note.
collectedbooleanSave status reported with the note.
Author12 fields

data[].user

Author profile information returned with the note.

FieldTypeDescription
idstringAuthor ID returned with the profile.
useridstringAuthor user ID returned with the profile.
namestringAuthor name as returned in the profile.
nicknamestringAuthor display nickname.
red_idstringAuthor's Xiaohongshu account handle.
imagestringAuthor profile image URL.
image_size_largestringLarge author profile image URL, when provided.
followedbooleanFollow status reported with the author profile.
red_official_verifiedbooleanWhether the author profile is marked as officially verified.
red_official_verify_typeintegerNumeric official verification type code.
levelobjectAuthor level badge information.
level.imagestringImage URL for the author level badge.
Topics and mentions23 fields

data[]

FieldTypeDescription
topicsarrayTopics associated with the video note.
topics[]objectA topic associated with the note.
topics[].idstringTopic ID.
topics[].namestringTopic name.
topics[].imagestringImage URL associated with the topic.
topics[].linkstringNavigation link returned for the topic.
topics[].discuss_numintegerDiscussion count reported for the topic.
hash_tagarrayHashtag information returned with the note.
hash_tag[]objectA hashtag attached to the note.
hash_tag[].idstringHashtag ID.
hash_tag[].namestringHashtag display name.
hash_tag[].linkstringNavigation link returned for the hashtag.
hash_tag[].typestringHashtag type label.
hash_tag[].tag_hintstringDisplay hint for the hashtag.
atsarrayAccounts mentioned in the note, when present.
ats[]objectAn account mentioned in the note.
ats[].idstringMentioned account ID.
ats[].namestringName returned for the mentioned account.
ats[].nicknamestringDisplay nickname of the mentioned account.
ats[].red_official_verifiedbooleanWhether the mentioned account is marked as officially verified.
ats[].red_official_verify_typeintegerNumeric official verification type code.
ats[].levelobjectMentioned account level badge information.
ats[].level.imagestringImage URL for the mentioned account level badge.
Covers and images17 fields

data[]

FieldTypeDescription
images_listarrayImage assets attached to the video note, including available cover images.
images_list[]objectAn image asset for the video note.
images_list[].fileidstringImage resource ID.
images_list[].indexintegerPosition index reported for this image.
images_list[].urlstringImage URL.
images_list[].originalstringOriginal image URL, when provided.
images_list[].url_size_largestringLarge image URL, when provided.
images_list[].widthintegerImage width in pixels.
images_list[].heightintegerImage height in pixels.
images_list[].origin_imgobjectOriginal image metadata when provided.
images_list[].origin_img.widthintegerOriginal image width in pixels.
images_list[].origin_img.heightintegerOriginal image height in pixels.
images_list[].origin_img.sizeintegerSize value reported for the original image.
video_info_v2.imageobjectPreview image URLs returned with the video.
video_info_v2.image.first_framestringFirst-frame image URL, when provided.
video_info_v2.image.thumbnailstringVideo thumbnail URL.
video_info_v2.image.thumbnail_dimstringAdditional thumbnail URL returned for the video.
Video overview15 fields

data[].video_info_v2

Video, image, and media stream metadata for the note.

FieldTypeDescription
consumerobjectPlayback capabilities reported for the video.
consumer.can_super_resolutionbooleanWhether the playback metadata marks super-resolution as available.
mediaobjectVideo and media stream metadata. Some groups may be unavailable or empty.
media.video_idstringVideo ID reported in the media metadata.
media.videoobjectInformation about the video as a whole.
media.video.durationintegerOverall video duration in seconds.
media.video.widthintegerVideo width in pixels.
media.video.heightintegerVideo height in pixels.
media.video.hdr_typeintegerNumeric HDR type code reported for the video.
media.video.drm_typeintegerNumeric DRM type code reported for the video.
media.video.stream_typesarrayNumeric video stream type codes reported for the video.
media.video.stream_types[]integerA video stream type code.
media.streamobjectVideo renditions grouped by codec family. Some groups can be empty.
media.stream.av1arrayAV1 stream group as returned. The group can be empty.
media.stream.h266arrayH.266 stream group as returned. The group can be empty.
H.264 video streams26 fields

data[].video_info_v2.media.stream

FieldTypeDescription
h264arrayH.264 video streams returned for the note.
h264[]objectA video stream rendition and its available audio metadata.
h264[].master_urlstringPrimary media URL for this rendition.
h264[].backup_urlsarrayAlternative media URLs for this rendition.
h264[].backup_urls[]stringAn alternative media URL.
h264[].formatstringContainer format label for the media file.
h264[].quality_typestringQuality label reported for this video rendition.
h264[].stream_descstringDisplay description for this media rendition.
h264[].stream_typeintegerNumeric stream type code returned for this rendition.
h264[].widthintegerEncoded video width in pixels.
h264[].heightintegerEncoded video height in pixels.
h264[].fpsintegerFrame rate reported in frames per second.
h264[].durationintegerTotal duration of this media stream in milliseconds.
h264[].video_durationintegerDuration of the video track in milliseconds.
h264[].audio_durationintegerDuration of the audio track in milliseconds.
h264[].sizeintegerSize of this encoded media file in bytes.
h264[].avg_bitrateintegerAverage bitrate of this media stream in bits per second.
h264[].video_bitrateintegerVideo track bitrate in bits per second.
h264[].audio_bitrateintegerAudio track bitrate in bits per second.
h264[].audio_channelsintegerNumber of audio channels reported for this track.
h264[].audio_codecstringAudio codec name reported for this track.
h264[].video_codecstringVideo codec name reported for this track.
h264[].rotateintegerRotation value reported for this video rendition.
h264[].psnrintegerPSNR quality value on the scale returned by the platform.
h264[].ssimintegerSSIM quality value on the scale returned by the platform.
h264[].vmafintegerVMAF quality value on the scale returned by the platform.
H.265 video streams26 fields

data[].video_info_v2.media.stream

FieldTypeDescription
h265arrayH.265 video streams returned for the note.
h265[]objectA video stream rendition and its available audio metadata.
h265[].master_urlstringPrimary media URL for this rendition.
h265[].backup_urlsarrayAlternative media URLs for this rendition.
h265[].backup_urls[]stringAn alternative media URL.
h265[].formatstringContainer format label for the media file.
h265[].quality_typestringQuality label reported for this video rendition.
h265[].stream_descstringDisplay description for this media rendition.
h265[].stream_typeintegerNumeric stream type code returned for this rendition.
h265[].widthintegerEncoded video width in pixels.
h265[].heightintegerEncoded video height in pixels.
h265[].fpsintegerFrame rate reported in frames per second.
h265[].durationintegerTotal duration of this media stream in milliseconds.
h265[].video_durationintegerDuration of the video track in milliseconds.
h265[].audio_durationintegerDuration of the audio track in milliseconds.
h265[].sizeintegerSize of this encoded media file in bytes.
h265[].avg_bitrateintegerAverage bitrate of this media stream in bits per second.
h265[].video_bitrateintegerVideo track bitrate in bits per second.
h265[].audio_bitrateintegerAudio track bitrate in bits per second.
h265[].audio_channelsintegerNumber of audio channels reported for this track.
h265[].audio_codecstringAudio codec name reported for this track.
h265[].video_codecstringVideo codec name reported for this track.
h265[].rotateintegerRotation value reported for this video rendition.
h265[].psnrnumberPSNR quality value on the scale returned by the platform.
h265[].ssimintegerSSIM quality value on the scale returned by the platform.
h265[].vmafintegerVMAF quality value on the scale returned by the platform.
Subtitle tracks6 fields

data[].video_info_v2.media.video.subtitles

Subtitle tracks grouped by returned key. Keys can include a language label or the source entry.

FieldTypeDescription
{key}arraySubtitle tracks under this key.
{key}[]objectA subtitle track.
{key}[].languagestringLanguage label returned for this subtitle track.
{key}[].urlstringFile URL for this subtitle track.
{key}[].formatintegerNumeric format code returned for this subtitle track.
{key}[].typeintegerNumeric type code returned for this subtitle track.
Audio-only renditions20 fields

data[].video_info_v2.media

FieldTypeDescription
audio_streamobjectAudio-only renditions when available. This object can be empty.
audio_stream.AACarrayAAC audio-only renditions returned for the video.
audio_stream.AAC[]objectAn AAC audio-only rendition.
audio_stream.AAC[].master_urlstringPrimary media URL for this rendition.
audio_stream.AAC[].backup_urlsarrayAlternative media URLs for this rendition.
audio_stream.AAC[].backup_urls[]stringAn alternative media URL.
audio_stream.AAC[].formatstringContainer format label for the media file.
audio_stream.AAC[].stream_typeintegerNumeric stream type code returned for this rendition.
audio_stream.AAC[].audio_codecstringAudio codec name reported for this track.
audio_stream.AAC[].audio_profilestringAudio codec profile reported for this track.
audio_stream.AAC[].audio_channelsintegerNumber of audio channels reported for this track.
audio_stream.AAC[].audio_samplerateintegerSample rate value reported for this audio-only track.
audio_stream.AAC[].audio_bit_depthintegerSample bit depth reported for this track.
audio_stream.AAC[].audio_durationintegerDuration value reported for this audio-only rendition.
audio_stream.AAC[].sizeintegerEncoded size value reported for this audio-only rendition.
audio_stream.AAC[].avg_bitrateintegerAverage bitrate reported for this audio-only rendition.
audio_stream.AAC[].audio_bitrateintegerAudio bitrate reported for this audio-only rendition.
audio_infoobjectAudio stream information when provided.
audio_info.stream_typesarrayNumeric audio stream type codes reported with the audio metadata.
audio_info.stream_types[]integerAn audio stream type code.
Sound attached to the note10 fields

data[]

FieldTypeDescription
native_voice_infoobjectVoice or sound metadata attached to the note when available.
native_voice_info.sound_idstringID of the attached sound.
native_voice_info.urlstringMedia URL for the attached sound.
native_voice_info.deeplinkstringNavigation link returned for the attached sound.
native_voice_info.use_countintegerUse count reported for this sound.
simple_music_infoobjectMusic metadata attached to the note when available.
simple_music_info.music_idstringID of the attached music.
simple_music_info.namestringName returned for the attached music.
simple_music_info.urlstringMedia URL for the attached music.
simple_music_info.deeplinkstringNavigation link returned for the attached music.
Sharing and note statements10 fields

data[]

FieldTypeDescription
note_statementobjectNote statements and attribution shown when available.
note_statement.origin_infoobjectContent origin information shown for the note.
note_statement.origin_info.origin_textstringContent origin text shown with the note.
note_statement.origin_info.origin_linkstringNavigation link returned with the content origin text.
share_infoobjectShare information returned for the note.
share_info.titlestringTitle for sharing the note.
share_info.contentstringText for sharing the note.
share_info.imagestringImage URL for sharing the note.
share_info.linkstringLink for sharing the note.
share_info.wechat_share_descstringSharing description returned for WeChat.
Note status and settings14 fields

data[]

FieldTypeDescription
stickybooleanPinned status reported with the note.
has_related_goodsbooleanWhether the note is marked as having related products.
related_goods_numintegerNumber of related products reported for the note.
media_save_configobjectMedia-saving settings returned for the note.
media_save_config.disable_savebooleanWhether the returned configuration disables saving media.
media_save_config.disable_watermarkbooleanWhether the returned configuration disables watermarking.
comment_prompt_configobjectComment prompt information returned with the note.
comment_prompt_config.placeholder_shortstringShort placeholder text for the comment input.
comment_prompt_config.placeholder_longstringLong placeholder text for the comment input.
function_switcharrayFeature switch states returned with the note.
function_switch[]objectA returned feature switch.
function_switch[].typestringFeature switch type label.
function_switch[].enablebooleanWhether this feature switch is enabled.
function_switch[].reasonstringReason text returned with this switch, when provided.

Response Example ​

Loading the response example...