XHS (Xiaohongshu) Usage Guide

Xiaohongshu API documentation organized based on TikHub OpenAPI (https://api.tikhub.io).

1. Single Note
- 1.1 Image Note (Text-and-Image Note)
- 1.2 Video Note
2. User Information
3. User Works
4. Comments
- 4.1 Top-level Comments
- 4.2 Second-level Comments (Sub-comments)
5. Search
- 5.1 Search Notes
- 5.2 Search Users
6. Topics
- 6.1 Topic Details
- 6.2 Topic Note List

General Notes

a. Calling strategy: use multiple series in combination (important)

At present, the most stable Xiaohongshu API series is App V2. It is strongly recommended that all users adopt a "primary series + 1~2 backup series" combination strategy, using 2~3 series together to improve overall business availability.

b. Call priority: App V2 (recommended) > App V1 (fallback) > Web V3 (third option)

App V2 is the primary recommended series. It is currently the most stable and has the most complete data, so it is recommended as the first choice; App V1 is close to App V2 in terms of field definitions and is suitable as the first backup fallback; Web V3 is the third backup Web channel open to enterprise users, requiring xsec_token (which can be extracted from a share link). However, the data dimensions returned are fewer than App V2 / App V1, so even enterprise users are advised to combine multiple series reasonably rather than using only Web V3; Web V2 / Web series only have a small number of available interfaces and stability is not guaranteed, so they are not recommended as the main option and should only be used as a supplement when the first three series do not meet requirements.

c. One-sentence recommendation: Do not rely on just one series. In production, it is recommended to configure at least 2 series for primary/backup use; when enterprise users use Web V3, please additionally combine it with App V2 / App V1 to make up for missing data dimensions.

d. Returned field reminder: App series interfaces (App V2 / App V1) have similar structures, and field names can basically correspond to each other; however, Web series interfaces (Web V3 / Web V2 / Web) return JSON structures that differ from one another, and field names, nesting levels, and data dimensions may all be different. When using them, be sure to first check the actual returned JSON fields of each interface before parsing and mapping.

1. Single Note

Xiaohongshu notes are divided into two types: image notes (text-and-image notes) and video notes. The App V2 series provides separate endpoints for both types, with the most complete data; Web V3 uses the same interface for both types, distinguished by response fields.

General recommendation: prioritize the App V2 series; enterprise users can combine it with Web V3 in scenarios where they can obtain xsec_token.

Comprehensive example: using three series together to get single note details

Below is a sample code snippet demonstrating the combined calling approach of primary series (App V2) → backup 1 (App V1) → backup 2 (Web V3), trying in order of priority; if the previous one succeeds, return immediately, otherwise fall back to the next one.

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

NOTE_ID = "697c0eee000000000a03c308"
XSEC_TOKEN = "ABxxxxxxxxxxxxxx"   # Required for Web V3, extract from share link / Web V3 需要，可从分享链接抽取
IS_VIDEO = False                  # Note type: True=video note, False=image note / 笔记类型：True=视频笔记，False=图文笔记


# --- Primary: App V2 / 主系列：App V2 ---
def fetch_by_app_v2(note_id: str, is_video: bool):
    if is_video:
        path = "/api/v1/xiaohongshu/app_v2/get_video_note_detail"
    else:
        path = "/api/v1/xiaohongshu/app_v2/get_image_note_detail"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"note_id": note_id})


# --- Fallback 1: App V1 (image notes only; no video download URL, not recommended for videos) / 备用 1：App V1（仅图文有效，视频不含下载链接，不建议用于视频）---
def fetch_by_app_v1(note_id: str):
    path = "/api/v1/xiaohongshu/app/get_note_info"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"note_id": note_id})


# --- Fallback 2: Web V3 (enterprise users only, requires xsec_token) / 备用 2：Web V3（企业用户专用，需要 xsec_token）---
def fetch_by_web_v3(note_id: str, xsec_token: str):
    path = "/api/v1/xiaohongshu/web_v3/fetch_note_detail"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"note_id": note_id, "xsec_token": xsec_token})


# --- Try all three series in order / 三系列依次尝试 ---
def get_note_detail(note_id: str, xsec_token: str, is_video: bool):
    # 1) Primary: App V2 / 主系列：App V2
    try:
        r = fetch_by_app_v2(note_id, is_video)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    # 2) Fallback 1: App V1 (skip this step for video notes) / 备用 1：App V1（视频笔记建议跳过此步）
    if not is_video:
        try:
            r = fetch_by_app_v1(note_id)
            if r.ok and r.json().get("code") == 200:
                return {"source": "app_v1", "data": r.json()}
        except Exception as e:
            print("App V1 调用失败：", e)

    # 3) Fallback 2: Web V3 / 备用 2：Web V3
    try:
        r = fetch_by_web_v3(note_id, xsec_token)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = get_note_detail(NOTE_ID, XSEC_TOKEN, IS_VIDEO)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series; since the returned structures differ across series, it is recommended to write separate parsing logic for each series.

1.1 Image Note (Text-and-Image Note)

1.1.1 [App V2] Get text-and-image note details ⭐ Recommended

Get the full detail data of a text-and-image note (image URLs, title, body, tags, engagement data, etc.).

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_image_note_detail
Official docs: docs.tikhub.io/420136391e0
Parameters:
- note_id (string, optional): note ID, e.g. "697c0eee000000000a03c308"
- share_text (string, optional): Xiaohongshu share link (supports APP / Web)
- Either one of the two; note_id is preferred; if both are provided, note_id takes precedence

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_image_note_detail"
params = {
    "note_id": "697c0eee000000000a03c308",
    # "share_text": "https://www.xiaohongshu.com/discovery/item/...",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

1.1.2 [App V1] Get note information V1 (text-and-image only, no video download link)

The App V1 note interface is only applicable to text-and-image notes. The response does not include a video download link, so do not use it to fetch video notes; for video notes, use App V2's get_video_note_detail instead.

Method: GET
Path: /api/v1/xiaohongshu/app/get_note_info
Official docs: docs.tikhub.io/310965839e0
Parameters:
- note_id (string, optional)
- share_text (string, optional)
- Either one of the two; note_id is preferred

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_note_info"
params = {
    "note_id": "697c0eee000000000a03c308",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

1.1.3 [Web V3] Get note details (text/image and video)

Web V3 endpoint, applicable to both text/image and video. Requires xsec_token (extracted from the share link, see the "supporting tool interfaces" above).

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_note_detail
Official docs: docs.tikhub.io/438852168e0
Parameters:
- note_id (string, required)
- xsec_token (string, required)

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_note_detail"
params = {
    "note_id": "697c0eee000000000a03c308",
    "xsec_token": "ABxxxxxxxxxxxxxx",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

1.2 Video Note

Do not use App V1's get_note_info for video notes, as the returned content does not include a video download link. Please use the App V2 or Web V3 options below.

1.2.1 [App V2] Get video note details ⭐ Recommended

Get the full detail data of a video note (video URL, cover, duration, title, body, engagement data, etc.).

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_video_note_detail
Official docs: docs.tikhub.io/420136392e0
Parameters:
- note_id (string, optional): e.g. "697c0eee000000000a03c308"
- share_text (string, optional)
- Either one of the two; note_id is preferred

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_video_note_detail"
params = {
    "note_id": "697c0eee000000000a03c308",
    # "share_text": "https://www.xiaohongshu.com/discovery/item/...",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

1.2.2 [Web V3] Get note details (video supported)

Same endpoint as text/image; call with note_id + xsec_token.

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_note_detail
Official docs: docs.tikhub.io/438852168e0

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_note_detail"
params = {
    "note_id": "697c0eee000000000a03c308",
    "xsec_token": "ABxxxxxxxxxxxxxx",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

2. User Information

Use user_id to obtain a Xiaohongshu user's public profile information (nickname, avatar, bio, follower count, following count, note count, etc.). All three series provide user information interfaces; App V2 has the most complete fields, while App V1 / Web V3 are suitable as backups.

General recommendation: prioritize the App V2 series; if only user_id is available, you can also use App V1 / Web V3.

💡 Don't know how to get user_id? You can first use the /api/v1/xiaohongshu/app/get_user_id_and_xsec_token tool interface (official docs) to pass in any Xiaohongshu user profile share link (either long or short link is fine), and it will parse out user_id and xsec_token, which can then be fed into the user information interfaces below. See 2.3 below for details.

Comprehensive example: using three series together to get user information

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

USER_ID = "61b46d790000000010008153"


# --- Primary: App V2 / 主系列：App V2 ---
def fetch_user_by_app_v2(user_id: str):
    path = "/api/v1/xiaohongshu/app_v2/get_user_info"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id})


# --- Fallback 1: App V1 / 备用 1：App V1 ---
def fetch_user_by_app_v1(user_id: str):
    path = "/api/v1/xiaohongshu/app/get_user_info"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id})


# --- Fallback 2: Web V3 / 备用 2：Web V3 ---
def fetch_user_by_web_v3(user_id: str):
    path = "/api/v1/xiaohongshu/web_v3/fetch_user_info"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id})


# --- Try all three series in order / 三系列依次尝试 ---
def get_user_info(user_id: str):
    # 1) Primary: App V2 / 主系列：App V2
    try:
        r = fetch_user_by_app_v2(user_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    # 2) Fallback 1: App V1 / 备用 1：App V1
    try:
        r = fetch_user_by_app_v1(user_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    # 3) Fallback 2: Web V3 / 备用 2：Web V3
    try:
        r = fetch_user_by_web_v3(user_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = get_user_info(USER_ID)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series; since the returned structures differ across series, it is recommended to write separate parsing logic for each series.

2.1 [App V2] Get user information ⭐ Recommended

Get detailed information for a specified user, including nickname, avatar, bio, follower count, following count, note count, etc.

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_user_info
Official docs: docs.tikhub.io/420136395e0
Parameters:
- user_id (string, optional): user ID, e.g. "61b46d790000000010008153"
- share_text (string, optional): Xiaohongshu user share link (supports APP / Web)
- Either one of the two; user_id is preferred; if both are provided, user_id takes precedence

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_user_info"
params = {
    "user_id": "61b46d790000000010008153",
    # "share_text": "https://www.xiaohongshu.com/user/profile/...",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

2.2 [App V1] Get user information

App V1 user information interface.

Method: GET
Path: /api/v1/xiaohongshu/app/get_user_info
Official docs: docs.tikhub.io/310965845e0
Parameters:
- user_id (string, required)

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_user_info"
params = {
    "user_id": "61b46d790000000010008153",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

If you only have a user profile share link (both long and short links are supported), you can first use this interface to parse out user_id and xsec_token, and then call the user information interface above.

Method: GET
Path: /api/v1/xiaohongshu/app/get_user_id_and_xsec_token
Official docs: docs.tikhub.io/364605901e0
Parameters:
- share_link (string, required): Xiaohongshu user share link

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_user_id_and_xsec_token"
params = {
    "share_link": "https://xhslink.com/m/xxxxx",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())
# Example response fields / 返回示例字段:
# {
#   "data": {
#       "user_id": "61b46d790000000010008153",
#       "xsec_token": "ABxxxxxxxxxxxxxx"
#   }
# }

2.4 [Web V3] Get user information

Web V3 user public profile interface, requiring only user_id.

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_user_info
Official docs: docs.tikhub.io/438852177e0
Parameters:
- user_id (string, required)

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_user_info"
params = {
    "user_id": "61b46d790000000010008153",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

3. User Works

Fetch the list of notes posted by the user according to user_id (mixed text/image and video). All interfaces use cursor-based pagination (cursor). The App V2 series additionally provides a "user public favorite notes list" interface (faved notes), while App V1 / Web V3 only cover "published notes".

General recommendation: prioritize the App V2 series; if only user_id is available, you can also use App V1 / Web V3.

💡 Don't know how to get user_id? Refer to the tool interface in 2.3 above (official docs).

Comprehensive example: using three series together to get a user's published notes

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

USER_ID = "61b46d790000000010008153"
CURSOR = ""   # Empty for first request; pass previous response's cursor for pagination / 首次请求留空；翻页时传上一次返回的 cursor


# --- Primary: App V2 / 主系列：App V2 ---
def fetch_user_notes_app_v2(user_id: str, cursor: str = ""):
    path = "/api/v1/xiaohongshu/app_v2/get_user_posted_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id, "cursor": cursor})


# --- Fallback 1: App V1 / 备用 1：App V1 ---
def fetch_user_notes_app_v1(user_id: str, cursor: str = ""):
    path = "/api/v1/xiaohongshu/app/get_user_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id, "cursor": cursor})


# --- Fallback 2: Web V3 / 备用 2：Web V3 ---
def fetch_user_notes_web_v3(user_id: str, cursor: str = "", num: int = 30):
    path = "/api/v1/xiaohongshu/web_v3/fetch_user_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS,
                        params={"user_id": user_id, "cursor": cursor, "num": num})


# --- Try all three series in order / 三系列依次尝试 ---
def get_user_notes(user_id: str, cursor: str = ""):
    # 1) Primary: App V2 / 主系列：App V2
    try:
        r = fetch_user_notes_app_v2(user_id, cursor)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    # 2) Fallback 1: App V1 / 备用 1：App V1
    try:
        r = fetch_user_notes_app_v1(user_id, cursor)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    # 3) Fallback 2: Web V3 / 备用 2：Web V3
    try:
        r = fetch_user_notes_web_v3(user_id, cursor)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = get_user_notes(USER_ID, CURSOR)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series; since the returned structures differ across series, it is recommended to write separate parsing logic for each series.

3.1 [App V2] Get a user's published note list ⭐ Recommended

Get the list of notes published by the specified user, using cursor-based pagination.

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_user_posted_notes
Official docs: docs.tikhub.io/420136396e0
Parameters:
- user_id (string, optional): user ID, e.g. "61b46d790000000010008153"
- share_text (string, optional): Xiaohongshu user share link (supports APP / Web)
- Either one of the two; user_id is preferred; if both are provided, user_id takes precedence
- cursor (string, optional): pagination cursor; leave blank for the first request; when paging, take the notes of the last note in the cursor list from the previous response (path example: $.data.data.notes[-1].cursor)

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_user_posted_notes"
params = {
    "user_id": "61b46d790000000010008153",
    "cursor": "",   # Empty for first request / 首次留空
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

3.2 [App V2] Get a user's publicly favorited note list (App V2 only)

Get the list of notes publicly favorited by the specified user (not notes posted by the user themselves, but content they have favorited), using cursor-based pagination. This interface is only available in App V2; App V1 / Web V3 do not have the corresponding capability.

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_user_faved_notes
Official docs: docs.tikhub.io/420136397e0
Parameters:
- user_id (string, optional): e.g. "5a8cf39111be10466d285d6b"
- share_text (string, optional)
- Either one of the two; user_id is preferred
- cursor (string, optional): pagination cursor; leave blank for the first request; when paging, pass the note_id of the last note on the previous page

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_user_faved_notes"
params = {
    "user_id": "5a8cf39111be10466d285d6b",
    "cursor": "",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

3.3 [App V1] Get user works list

App V1 user works interface, covering only published notes, using cursor-based pagination.

Method: GET
Path: /api/v1/xiaohongshu/app/get_user_notes
Official docs: docs.tikhub.io/310965846e0
Parameters:
- user_id (string, required)
- cursor (string, optional): leave blank for the first request; when paging, take the notes of the last note in the note_id list from the previous page

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_user_notes"
params = {
    "user_id": "61b46d790000000010008153",
    "cursor": "",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

Returned structure (key fields):

notes[]: note array, each item includes note_id, type (normal = text/image / video = video), display_title, desc, liked_count, cover, user, etc.
cursor: next-page cursor
has_more: whether there is more data

3.4 [Web V3] Get user note list

Web V3 user works interface, using cursor-based pagination, with support for specifying the number of items per page (maximum 30).

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_user_notes
Official docs: docs.tikhub.io/438852178e0
Parameters:
- user_id (string, required)
- cursor (string, optional): pagination cursor
- num (integer, optional): items per page, default 30, maximum 30

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_user_notes"
params = {
    "user_id": "61b46d790000000010008153",
    "cursor": "",
    "num": 30,
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4. Comments

Xiaohongshu comments are divided into two levels: top-level comments (the comment list under a note) and second-level comments (replies/sub-comment list under a specific comment). All three series provide these two levels of interfaces; App V2 has the richest fields, while App V1 / Web V3 are suitable as backups.

General recommendation: prioritize the App V2 series; the Web V3 interface requires xsec_token (which can be extracted from the share link, see the comprehensive example in 1. Single Note / the tool interface in 2.3).

4.1 Top-level Comments (comment list under a note)

Comprehensive example: using three series together to get top-level comments

Below is a sample code snippet demonstrating the combined calling approach of primary series (App V2) → backup 1 (App V1) → backup 2 (Web V3).

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

NOTE_ID = "697c0eee000000000a03c308"
XSEC_TOKEN = "ABxxxxxxxxxxxxxx"   # Required for Web V3 / Web V3 需要


# --- Primary: App V2 / 主系列：App V2 ---
def fetch_comments_app_v2(note_id: str, cursor: str = "", index: int = 0):
    path = "/api/v1/xiaohongshu/app_v2/get_note_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "cursor": cursor,
        "index": index,
        "pageArea": "UNFOLDED",
        "sort_strategy": "latest_v2",
    })


# --- Fallback 1: App V1 / 备用 1：App V1 ---
def fetch_comments_app_v1(note_id: str, start: str = ""):
    path = "/api/v1/xiaohongshu/app/get_note_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "start": start,
        "sort_strategy": 1,
    })


# --- Fallback 2: Web V3 / 备用 2：Web V3 ---
def fetch_comments_web_v3(note_id: str, xsec_token: str, cursor: str = ""):
    path = "/api/v1/xiaohongshu/web_v3/fetch_note_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "xsec_token": xsec_token,
        "cursor": cursor,
    })


# --- Try all three series in order / 三系列依次尝试 ---
def get_note_comments(note_id: str, xsec_token: str):
    try:
        r = fetch_comments_app_v2(note_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    try:
        r = fetch_comments_app_v1(note_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    try:
        r = fetch_comments_web_v3(note_id, xsec_token)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = get_note_comments(NOTE_ID, XSEC_TOKEN)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series.

4.1.1 [App V2] Get note comment list ⭐ Recommended

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_note_comments
Official docs: docs.tikhub.io/420136394e0
Parameters:
- note_id (string, optional): note ID
- share_text (string, optional): share link (either note_id or note_id; note_id is preferred)
- cursor (string, optional): pagination cursor, leave blank for the first request
- index (integer, optional): comment index, pass 0 on the first request
- pageArea (string, optional): collapse state, UNFOLDED (default) / FOLDED
- sort_strategy (string, optional): sort order, default / latest_v2 (default) / like_count

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_note_comments"
params = {
    "note_id": "697c0eee000000000a03c308",
    "cursor": "",
    "index": 0,
    "pageArea": "UNFOLDED",
    "sort_strategy": "latest_v2",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4.1.2 [App V1] Get note comments

Method: GET
Path: /api/v1/xiaohongshu/app/get_note_comments
Official docs: docs.tikhub.io/310965840e0
Parameters:
- note_id (string, required)
- start (string, optional): pagination cursor, leave blank for the first request; supports two formats — simple format (e.g. "682b0133000000001c03618d") or JSON format (e.g. {"cursor":"...","index":2,"pageArea":"UNFOLDED"})
- sort_strategy (integer, optional): 1 - default order (default) / 2 - latest comments

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_note_comments"
params = {
    "note_id": "697c0eee000000000a03c308",
    "start": "",
    "sort_strategy": 1,
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4.1.3 [Web V3] Get note comments

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_note_comments
Official docs: docs.tikhub.io/438852169e0
Parameters:
- note_id (string, required)
- xsec_token (string, required): can be extracted from the share link
- cursor (string, optional): pagination cursor

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_note_comments"
params = {
    "note_id": "697c0eee000000000a03c308",
    "xsec_token": "ABxxxxxxxxxxxxxx",
    "cursor": "",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4.2 Second-level Comments (Sub-comments / reply list)

Get all replies (sub-comments) under a specific top-level comment; all three series cover this as well. Note that in Web V3 the parameter is called root_comment_id, while in the other two series it is called comment_id.

Comprehensive example: using three series together to get sub-comments

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

NOTE_ID = "699916e6000000001d0253da"
COMMENT_ID = "PARENT_COMMENT_ID"  # Top-level comment ID / 一级评论 ID
XSEC_TOKEN = "ABxxxxxxxxxxxxxx"   # Required for Web V3 / Web V3 需要


def fetch_sub_app_v2(note_id, comment_id, cursor="", index=1):
    path = "/api/v1/xiaohongshu/app_v2/get_note_sub_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "comment_id": comment_id,
        "cursor": cursor,
        "index": index,
    })


def fetch_sub_app_v1(note_id, comment_id, start=""):
    path = "/api/v1/xiaohongshu/app/get_sub_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "comment_id": comment_id,
        "start": start,
    })


def fetch_sub_web_v3(note_id, root_comment_id, xsec_token, cursor="", num=10):
    path = "/api/v1/xiaohongshu/web_v3/fetch_sub_comments"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "note_id": note_id,
        "root_comment_id": root_comment_id,
        "xsec_token": xsec_token,
        "cursor": cursor,
        "num": num,
    })


def get_sub_comments(note_id, comment_id, xsec_token):
    try:
        r = fetch_sub_app_v2(note_id, comment_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    try:
        r = fetch_sub_app_v1(note_id, comment_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    try:
        r = fetch_sub_web_v3(note_id, comment_id, xsec_token)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = get_sub_comments(NOTE_ID, COMMENT_ID, XSEC_TOKEN)
print(result)

4.2.1 [App V2] Get note second-level comment list ⭐ Recommended

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_note_sub_comments
Official docs: docs.tikhub.io/420748830e0
Parameters:
- note_id (string, optional)
- share_text (string, optional) (either note_id or note_id; note_id is preferred)
- comment_id (string, required): parent comment ID
- cursor (string, optional): leave blank for the first request; when paging, take it from $.data.cursor
- index (integer, optional): pass 1 on the first request; when paging, take it from $.data.cursor

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_note_sub_comments"
params = {
    "note_id": "699916e6000000001d0253da",
    "comment_id": "PARENT_COMMENT_ID",
    "cursor": "",
    "index": 1,
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4.2.2 [App V1] Get sub-comments

Method: GET
Path: /api/v1/xiaohongshu/app/get_sub_comments
Official docs: docs.tikhub.io/310965841e0
Parameters:
- note_id (string, required)
- comment_id (string, required): top-level comment ID
- start (string, optional): pagination cursor, taken from the last sub-comment ID on the previous page (e.g. "6806642d000000001f01991b")

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_sub_comments"
params = {
    "note_id": "697c0eee000000000a03c308",
    "comment_id": "PARENT_COMMENT_ID",
    "start": "",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

4.2.3 [Web V3] Get sub-comments

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_sub_comments
Official docs: docs.tikhub.io/438852170e0
Parameters:
- note_id (string, required)
- root_comment_id (string, required): parent comment ID
- xsec_token (string, required)
- num (integer, optional): number of items returned, default 10
- cursor (string, optional): pagination cursor

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_sub_comments"
params = {
    "note_id": "697c0eee000000000a03c308",
    "root_comment_id": "PARENT_COMMENT_ID",
    "xsec_token": "ABxxxxxxxxxxxxxx",
    "num": 10,
    "cursor": "",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

5. Search

Xiaohongshu search is divided into two categories: search notes and search users.

Search notes: provided by App V2 / App V1 / Web V3; App V2 has the richest fields (supports sorting, note type, time filtering, AI mode, etc.).
Search users: only provided by App V2 and Web V3; App V1 does not have a user search interface.

General recommendation: prioritize the App V2 series; when paging, remember to carry over the search_id / session_id returned by the first search (parameter names differ slightly across series).

5.1 Search Notes

Comprehensive example: using three series together to search notes

Below is a sample code snippet demonstrating the combined calling approach of primary series (App V2) → backup 1 (App V1) → backup 2 (Web V3).

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

KEYWORD = "美食推荐"
PAGE = 1


# --- Primary: App V2 / 主系列：App V2 ---
def search_notes_app_v2(keyword: str, page: int = 1):
    path = "/api/v1/xiaohongshu/app_v2/search_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "keyword": keyword,
        "page": page,
        "sort_type": "general",
        "note_type": "不限",
        "time_filter": "不限",
    })


# --- Fallback 1: App V1 / 备用 1：App V1 ---
def search_notes_app_v1(keyword: str, page: int = 1):
    path = "/api/v1/xiaohongshu/app/search_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "keyword": keyword,
        "page": page,
        "sort_type": "general",
        "filter_note_type": "不限",
        "filter_note_time": "不限",
    })


# --- Fallback 2: Web V3 / 备用 2：Web V3 ---
def search_notes_web_v3(keyword: str, page: int = 1):
    path = "/api/v1/xiaohongshu/web_v3/fetch_search_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "keyword": keyword,
        "page": page,
        "sort": "general",
        "note_type": 0,
    })


def search_notes(keyword: str, page: int = 1):
    try:
        r = search_notes_app_v2(keyword, page)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    try:
        r = search_notes_app_v1(keyword, page)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    try:
        r = search_notes_web_v3(keyword, page)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = search_notes(KEYWORD, PAGE)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series; when paging, remember to pass through the search_id / session_id from the first response.

5.1.1 [App V2] Search notes ⭐ Recommended

Method: GET
Path: /api/v1/xiaohongshu/app_v2/search_notes
Official docs: docs.tikhub.io/420136398e0
Parameters:
- keyword (string, required): search keyword, e.g. "美食推荐"
- page (integer, optional): page number, starting from 1
- sort_type (string, optional): sort order, general (comprehensive, default) / time_descending (latest) / popularity_descending (most liked) / comment_descending (most commented) / collect_descending (most favorited) / english_preferred (English first)
- note_type (string, optional): note type, 不限 (default) / 视频笔记 / 普通笔记 / 直播笔记
- time_filter (string, optional): publication time, 不限 (default) / 一天内 / 一周内 / 半年内
- search_id (string, optional): when paging, pass the value from the first response
- search_session_id (string, optional): when paging, pass the value from the first response
- source (string, optional): source, default explore_feed
- ai_mode (integer, optional): AI mode, 0 (off, default) / 1 (on)

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/search_notes"
params = {
    "keyword": "美食推荐",
    "page": 1,
    "sort_type": "general",
    "note_type": "不限",
    "time_filter": "不限",
    # Pass search_id and search_session_id from first response for pagination / 翻页时需要带上首次响应里的 search_id 和 search_session_id
    # "search_id": "...",
    # "search_session_id": "...",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

5.1.2 [App V1] Search notes

Method: GET
Path: /api/v1/xiaohongshu/app/search_notes
Official docs: docs.tikhub.io/310965843e0
Parameters:
- keyword (string, required)
- page (integer, required): page number, starting from 1
- search_id (string, optional): when paging, pass the value from the first response
- session_id (string, optional): when paging, pass the value from the first response
- sort_type (string, optional): general (default) / time_descending / popularity_descending / comment_descending / collect_descending
- filter_note_type (string, optional): 不限 (default) / 视频笔记 / 普通笔记
- filter_note_time (string, optional): 不限 (default) / 一天内 / 一周内 / 半年内

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app/search_notes"
params = {
    "keyword": "美食推荐",
    "page": 1,
    "sort_type": "general",
    "filter_note_type": "不限",
    "filter_note_time": "不限",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

5.1.3 [Web V3] Search notes

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_search_notes
Official docs: docs.tikhub.io/438852171e0
Parameters:
- keyword (string, required)
- page (integer, optional): default 1
- sort (string, optional): general (comprehensive, default) / time_descending (latest) / popularity_descending (hottest)
- note_type (integer, optional): 0 = all (default) / 1 = text/image / 2 = video

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_search_notes"
params = {
    "keyword": "美食推荐",
    "page": 1,
    "sort": "general",
    "note_type": 0,
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

5.2 Search Users

⚠️ Note: App V1 does not have a user search interface; this section only includes the App V2 and Web V3 series.

Comprehensive example: using two series together to search users

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

KEYWORD = "美食博主"
PAGE = 1


# --- Primary: App V2 / 主系列：App V2 ---
def search_users_app_v2(keyword: str, page: int = 1, search_id: str = ""):
    path = "/api/v1/xiaohongshu/app_v2/search_users"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "keyword": keyword,
        "page": page,
        "search_id": search_id,
    })


# --- Fallback: Web V3 / 备用：Web V3 ---
def search_users_web_v3(keyword: str, page: int = 1):
    path = "/api/v1/xiaohongshu/web_v3/fetch_search_users"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "keyword": keyword,
        "page": page,
    })


def search_users(keyword: str, page: int = 1):
    try:
        r = search_users_app_v2(keyword, page)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    try:
        r = search_users_web_v3(keyword, page)
        if r.ok and r.json().get("code") == 200:
            return {"source": "web_v3", "data": r.json()}
    except Exception as e:
        print("Web V3 调用失败：", e)

    return None


result = search_users(KEYWORD, PAGE)
print(result)

5.2.1 [App V2] Search users ⭐ Recommended

Returns 20 results per page by default, with pagination supported.

Method: GET
Path: /api/v1/xiaohongshu/app_v2/search_users
Official docs: docs.tikhub.io/420136399e0
Parameters:
- keyword (string, required): search keyword, e.g. "美食博主"
- page (integer, optional): page number, starting from 1
- search_id (string, optional): when paging, pass the value from the first response
- source (string, optional): source, default explore_feed

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/search_users"
params = {
    "keyword": "美食博主",
    "page": 1,
    # Pass search_id from first response for pagination / 翻页时带上首次响应里的 search_id
    # "search_id": "...",
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

5.2.2 [Web V3] Search users

Method: GET
Path: /api/v1/xiaohongshu/web_v3/fetch_search_users
Official docs: docs.tikhub.io/438852172e0
Parameters:
- keyword (string, required)
- page (integer, optional): default 1

python
url = f"{BASE_URL}/api/v1/xiaohongshu/web_v3/fetch_search_users"
params = {
    "keyword": "口红",
    "page": 1,
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())

6. Topics

Xiaohongshu topic-related interfaces are divided into two parts: topic details and note list under a topic.

⚠️ Important note:

The Web V3 series does not have topic interfaces; this section only includes the App V2 and App V1 series.

App V1's old interface /api/v1/xiaohongshu/app/get_notes_by_topic is deprecated; please use get_topic_notes in this section instead.

All interfaces use page_id (topic/topic tag ID) as the unique identifier.

6.1 Topic Details

Only App V2 provides the topic details interface (topic name, views, discussion count, share information, etc.). App V1 / Web V3 do not have the corresponding capability.

6.1.1 [App V2] Get topic details ⭐ App V2 only

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_topic_info
Official docs: docs.tikhub.io/420136407e0
Parameters:
- page_id (string, required): topic page ID, e.g. "5c1cc866febed9000184b7c1"
- source (string, optional): source, default normal
- note_id (string, optional): source note ID, can be passed when jumping to a topic from a note

python
import requests

BASE_URL = "https://api.tikhub.io"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_topic_info"
params = {
    "page_id": "5c1cc866febed9000184b7c1",
    "source": "normal",
    # "note_id": "...",  # Optional: pass when navigating from a note / 从笔记跳转过来时可带
}
r = requests.get(url, headers=HEADERS, params=params)
print(r.json())
# Response contains page_info (name/views/discussions), tabs, share_info, etc. / 返回包含 page_info（名称/浏览量/讨论数）、tabs、share_info 等

6.2 Topic Note List (notes under a topic)

Get the list of notes under a certain topic/topic tag. Both App V2 and App V1 provide this, but the parameters and pagination fields differ significantly and need to be adapted separately.

Comprehensive example: using two series together to get topic notes

python
import requests
import time

BASE_URL = "https://api.tikhub.io"
HEADERS = {
    "Authorization": "Bearer YOUR_API_KEY",
    "accept": "application/json",
}

PAGE_ID = "5c1cc866febed9000184b7c1"


# --- Primary: App V2 / 主系列：App V2 ---
def topic_feed_app_v2(page_id: str, sort: str = "trend"):
    path = "/api/v1/xiaohongshu/app_v2/get_topic_feed"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "page_id": page_id,
        "sort": sort,        # trend (hottest) / time (latest) | trend(最热) / time(最新)
    })


# --- Fallback: App V1 / 备用：App V1 ---
def topic_notes_app_v1(page_id: str, sort: str = "hot"):
    path = "/api/v1/xiaohongshu/app/get_topic_notes"
    return requests.get(f"{BASE_URL}{path}", headers=HEADERS, params={
        "page_id": page_id,
        "first_load_time": str(int(time.time() * 1000)),  # Millisecond timestamp / 毫秒级时间戳
        "sort": sort,        # hot (general) / time (latest) / trend (hottest) | hot(综合) / time(最新) / trend(最热)
    })


def get_topic_notes(page_id: str):
    try:
        r = topic_feed_app_v2(page_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v2", "data": r.json()}
    except Exception as e:
        print("App V2 调用失败：", e)

    try:
        r = topic_notes_app_v1(page_id)
        if r.ok and r.json().get("code") == 200:
            return {"source": "app_v1", "data": r.json()}
    except Exception as e:
        print("App V1 调用失败：", e)

    return None


result = get_topic_notes(PAGE_ID)
print(result)

Tip: the success check above (code == 200) is only illustrative. In practice, please judge based on the JSON fields returned by each series; when paging, remember to pass through the corresponding cursor field (the fields differ between the two series, see below).

6.2.1 [App V2] Get topic note list ⭐ Recommended

Method: GET
Path: /api/v1/xiaohongshu/app_v2/get_topic_feed
Official docs: docs.tikhub.io/420136408e0
Parameters:
- page_id (string, required): topic page ID
- sort (string, optional): trend (hottest, default) / time (latest)
- cursor_score (string, optional): pagination cursor score; when paging, pass the cursor_score of the last item on the previous page
- last_note_id (string, optional): when paging, pass the last note ID from the previous page (items[-1].id)
- last_note_ct (string, optional): when paging, pass the creation time of the last note from the previous page (items[-1].create_time)
- session_id (string, optional): session ID, keep consistent when paging
- first_load_time (string, optional): initial load timestamp, keep consistent when paging
- source (string, optional): source, default normal

python
url = f"{BASE_URL}/api/v1/xiaohongshu/app_v2/get_topic_feed"

# First request: pass only page_id and sort / 首次请求：只传 page_id 和 sort
params = {
    "page_id": "5c1cc866febed9000184b7c1",
    "sort": "trend",
}
r = requests.get(url, headers=HEADERS, params=params)
data = r.json()
print(data)

# Next page: pass through the following fields from the first response / 翻页请求：从首次响应中取下列字段透传
# items = data["data"]["items"]
# next_params = {
#     "page_id": "5c1cc866febed9000184b7c1",
#     "sort": "trend",
#     "cursor_score": items[-1]["cursor_score"],
#     "last_note_id": items[-1]["id"],
#     "last_note_ct": items[-1]["create_time"],
#     "session_id": data["data"]["session_id"],
#     "first_load_time": data["data"]["first_load_time"],
# }

6.2.2 [App V1] Get works by topic tag (replacement for deprecated `get_notes_by_topic`)

⚠️ App V1's old interface /api/v1/xiaohongshu/app/get_notes_by_topic is deprecated; please use this interface directly.

Method: GET
Path: /api/v1/xiaohongshu/app/get_topic_notes
Official docs: docs.tikhub.io/454758056e0
Parameters:
- page_id (string, required): topic tag ID
- first_load_time (string, required): first request timestamp (milliseconds), Python retrieval: int(time.time() * 1000)
- sort (string, optional): hot (comprehensive, default) / time (latest) / trend (hottest)
- last_note_ct (string, optional): when paging, pass the create_time of the last note on the previous page
- last_note_id (string, optional): when paging, pass the last note ID from the previous page
- cursor_score (string, optional): when paging, pass the cursor_score of the last note on the previous page
- session_id (string, optional): session ID, generated by the server on the first request, return it when paging

python
import time

url = f"{BASE_URL}/api/v1/xiaohongshu/app/get_topic_notes"

# First request / 首次请求
params = {
    "page_id": "5c1cc866febed9000184b7c1",
    "first_load_time": str(int(time.time() * 1000)),
    "sort": "hot",
}
r = requests.get(url, headers=HEADERS, params=params)
data = r.json()
print(data)

# Next page: keep page_id / first_load_time unchanged, pass session_id and last_* through / 翻页请求：保持 page_id / first_load_time 不变，把 session_id 和 last_* 透传
# notes = data["data"]["notes"]
# next_params = {
#     "page_id": "5c1cc866febed9000184b7c1",
#     "first_load_time": params["first_load_time"],
#     "sort": "hot",
#     "session_id": data["data"]["session_id"],
#     "last_note_id": notes[-1]["id"],
#     "last_note_ct": notes[-1]["note"]["create_time"],
#     "cursor_score": notes[-1].get("cursor_score", ""),
# }

XHS (Xiaohongshu) Usage Guide

Table of Contents

General Notes

1. Single Note

Comprehensive example: using three series together to get single note details

1.1 Image Note (Text-and-Image Note)

1.1.1 [App V2] Get text-and-image note details ⭐ Recommended

1.1.2 [App V1] Get note information V1 (text-and-image only, no video download link)

1.1.3 [Web V3] Get note details (text/image and video)

1.2 Video Note

1.2.1 [App V2] Get video note details ⭐ Recommended

1.2.2 [Web V3] Get note details (video supported)

2. User Information

Comprehensive example: using three series together to get user information

2.1 [App V2] Get user information ⭐ Recommended

2.2 [App V1] Get user information

2.3 [App V1] Supporting tool: extract user_id and xsec_token from a user share link

2.4 [Web V3] Get user information

3. User Works

Comprehensive example: using three series together to get a user's published notes

3.1 [App V2] Get a user's published note list ⭐ Recommended

3.2 [App V2] Get a user's publicly favorited note list (App V2 only)

3.3 [App V1] Get user works list

3.4 [Web V3] Get user note list

4. Comments

4.1 Top-level Comments (comment list under a note)

Comprehensive example: using three series together to get top-level comments

4.1.1 [App V2] Get note comment list ⭐ Recommended

4.1.2 [App V1] Get note comments

4.1.3 [Web V3] Get note comments

4.2 Second-level Comments (Sub-comments / reply list)

Comprehensive example: using three series together to get sub-comments

4.2.1 [App V2] Get note second-level comment list ⭐ Recommended

4.2.2 [App V1] Get sub-comments

4.2.3 [Web V3] Get sub-comments

5. Search

5.1 Search Notes

Comprehensive example: using three series together to search notes

5.1.1 [App V2] Search notes ⭐ Recommended

5.1.2 [App V1] Search notes

5.1.3 [Web V3] Search notes

5.2 Search Users

Comprehensive example: using two series together to search users

5.2.1 [App V2] Search users ⭐ Recommended

5.2.2 [Web V3] Search users

6. Topics

6.1 Topic Details

6.1.1 [App V2] Get topic details ⭐ App V2 only

6.2 Topic Note List (notes under a topic)

Comprehensive example: using two series together to get topic notes

6.2.1 [App V2] Get topic note list ⭐ Recommended

6.2.2 [App V1] Get works by topic tag (replacement for deprecated get_notes_by_topic)

6.2.2 [App V1] Get works by topic tag (replacement for deprecated `get_notes_by_topic`)