> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/xiaohongshu/notes/noteid/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/xiaohongshu/notes/noteid/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Xiaohongshu note (https://www.socialfetch.dev/docs/api/v1/xiaohongshu/notes/noteid/get)

## Summary

Get a Xiaohongshu note by id or link with its text, topics, images or video, and its counts.

**Tags:** `Xiaohongshu`

## HTTP

- **Method:** GET
- **Path:** `/v1/xiaohongshu/notes/{noteId}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.xiaohongshu.getNote({ noteId: "68ad9c4b000000001b0339a6" })`
- **Accepted identifiers:** `noteId` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 1 credit
- Failed requests are free
- Found, empty and not-found answers are all charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `noteId` (path)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 1024
- **Description:** The note id, the 24 characters after `/explore/` or `/discovery/item/` in a note link, for example `68ad9c4b000000001b0339a6`. Most notes open only with the `xsec_token` of the link they were shared or listed with, so pass the whole note link (its token is read from it), the app's `xhslink.com` share link, or the id with `xsecToken`.

### `xsecToken` (query)

- **Required:** no
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9_\-+/=]{16,256}$`
- **Description:** The `xsec_token` from the note's link (the value after `xsec_token=`). Needed for most notes: without it Xiaohongshu shows logged-out visitors only notes it currently promotes. Read from the link when you pass a whole note link as `noteId`.

## Responses (status codes)

- **200**: A Xiaohongshu note.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

A Xiaohongshu note.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. `not_found` when Xiaohongshu refuses a note requested with an `xsec_token` (from the link or `xsecToken`): deleted, hidden or unknown. Without a token, a note Xiaohongshu will not show answers 400 `bad_request`, with no charge.
  - **note** (required) — type `object`; nullable. The note when `lookupStatus` is `found`; otherwise null.
    - **id** (required) — type `string`. Note id.
    - **url** (required) — type `string`. Note page.
    - **type** (required) — type `string`; enum: image, video, null; nullable. `image` for a photo note, `video` for a video note.
    - **title** (required) — type `string`; nullable. Title.
    - **description** (required) — type `string`; nullable. The note's text as plain text, with topics written `#name` and mentions `@name`.
    - **titleTranslation** (required) — type `string`; nullable. The site's English translation of the title, when it has one.
    - **descriptionTranslation** (required) — type `string`; nullable. The site's English translation of the text, when it has one.
    - **language** (required) — type `string`; nullable. The language the site detected, such as `zh_cn`.
    - **createdAt** (required) — type `string`; nullable. When the note was posted, ISO 8601 UTC.
    - **updatedAt** (required) — type `string`; nullable. When the note was last edited, ISO 8601 UTC.
    - **ipLocation** (required) — type `string`; nullable. The region the site shows the note was posted from, when it shows one.
    - **topics** (required) — type `array`. Topics on the note.
      - _items:_
    - **mentions** (required) — type `array`. Accounts the note mentions.
      - _items:_
    - **coverUrl** (required) — type `string`; nullable. Cover image. A signed link that expires: download it, do not store it.
    - **images** (required) — type `array`. The images, in order. A video note has its cover here.
      - _items:_
    - **video** (required) — type `object`; nullable. The video of a video note; null for a photo note.
      - **url** (required) — type `string`; nullable. The MP4 file. A signed link that expires: download it, do not store it.
      - **backupUrls** (required) — type `array`. Other copies of the same file, should `url` fail.
        - _items:_
          - type `string`
      - **durationSeconds** (required) — type `number`; nullable. Length in seconds, when known.
      - **width** (required) — type `integer`; nullable. Width in pixels.
      - **height** (required) — type `integer`; nullable. Height in pixels.
      - **bitrate** (required) — type `integer`; nullable. Average bitrate in bits per second.
      - **sizeBytes** (required) — type `integer`; nullable. File size in bytes.
    - **stats** (required) — type `object`. Engagement counters as the site shows them. Counts of 10,000 and more are rounded by the site (`94.3K`).
      - **likes** (required) — type `integer`; nullable. Likes.
      - **saves** (required) — type `integer`; nullable. Saves (collects).
      - **comments** (required) — type `integer`; nullable. Comments.
      - **shares** (required) — type `integer`; nullable. Shares.
    - **author** (required) — type `object`; nullable. The creator.
      - **id** (required) — type `string`. Xiaohongshu user id, the same on every endpoint: pass it as `profileId` to the profile endpoints.
      - **displayName** (required) — type `string`; nullable. Display name.
      - **avatarUrl** (required) — type `string`; nullable. Profile picture.
      - **url** (required) — type `string`. Profile page.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "note": {
      "id": "68ad9c4b000000001b0339a6",
      "url": "https://www.rednote.com/discovery/item/68ad9c4b000000001b0339a6",
      "type": "video",
      "title": "爆火的混色彩铅测评！在商场等餐时候画～",
      "description": "#生活画家创作挑战赛\n\t\n猜猜这三支彩铅在餐厅灯光下能混出多少种颜色？\n实测结果惊到路人hhh！\n（弱弱问：你们觉得值不值得冲？）  @手工薯 @画画薯\n#彩铅画 #手绘测评 #艺术生日常 #写生\n\t\n#带上兴趣出门 #彩铅 #一起画画 #随地大小画 #手绘 #画画应该是一件快乐的事 #一画一个不吱声 #彩铅插画 #写生",
      "titleTranslation": "Trying out these viral mixed-color pencils! Just doodling while waiting for my food at the mall~",
      "descriptionTranslation": "Guess how many colors you can mix with just these three pencils under restaurant lighting?  \nThe results were so surprising that people around me couldn't believe their eyes hhh!  \n(Just wondering: do you guys think they're worth getting?)  @手工薯 @画画薯",
      "language": "zh_cn",
      "createdAt": "2025-08-26T11:36:43.000Z",
      "updatedAt": "2025-08-26T11:36:44.000Z",
      "ipLocation": null,
      "topics": [
        {
          "id": "68468a2900000000130209a9",
          "name": "生活画家创作挑战赛",
          "nameTranslation": "lifepainterchallenge"
        }
      ],
      "mentions": [
        {
          "id": "616a6c220000000002018129",
          "displayName": "手工薯",
          "avatarUrl": null,
          "url": "https://www.rednote.com/user/profile/616a6c220000000002018129"
        }
      ],
      "coverUrl": "https://sns-web-i10.rednotecdn.com/202611170843/bca7e1cc52103fc9978e3b8e30ae7072/1040g00831ll783file005n2ahua47u610ukcnpg!nd_dft_wlteh_jpg_3",
      "images": [
        {
          "url": "https://sns-web-i10.rednotecdn.com/202611170843/bca7e1cc52103fc9978e3b8e30ae7072/1040g00831ll783file005n2ahua47u610ukcnpg!nd_dft_wlteh_jpg_3",
          "previewUrl": "https://sns-web-i10.rednotecdn.com/202611170843/57dc6fc5984d0a53430b12e5b935d3cd/1040g00831ll783file005n2ahua47u610ukcnpg!nd_prv_wlteh_jpg_3",
          "width": 1440,
          "height": 1920,
          "isLivePhoto": false
        }
      ],
      "video": {
        "url": "https://sns-v27.rednotecdn.com/stream/79/110/258/01e8ad9c4bbc939d4f03700198e62adcdb_258.mp4",
        "backupUrls": [
          "https://sns-v11.rednotecdn.com/stream/79/110/258/01e8ad9c4bbc939d4f03700198e62adcdb_258.mp4"
        ],
        "durationSeconds": 28.6,
        "width": 720,
        "height": 1280,
        "bitrate": 2174896,
        "sizeBytes": 7776887
      },
      "stats": {
        "likes": 94300,
        "saves": 8037,
        "comments": 364,
        "shares": 1222
      },
      "author": {
        "id": "5c4a8f94000000001003f8c1",
        "displayName": "陈吨吨",
        "avatarUrl": "https://sns-avatar-qc.rednotecdn.com/avatar/1040g2jo31jrc2kq130005n2ahua47u61nr0er30",
        "url": "https://www.rednote.com/user/profile/5c4a8f94000000001003f8c1"
      }
    }
  },
  "meta": {
    "requestId": "req_01example_xiaohongshu_note",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.xiaohongshu.getNote({
  noteId: "68ad9c4b000000001b0339a6",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/xiaohongshu/notes/68ad9c4b000000001b0339a6",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/xiaohongshu/notes/68ad9c4b000000001b0339a6" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/xiaohongshu/notes/68ad9c4b000000001b0339a6",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```