# RedNote (Xiaohongshu) Note (`rednote.note`)

One RedNote (Xiaohongshu) note by id: title, text, cover, author, engagement counts, location and timestamps.

Docs: https://primaryapi.com/docs/api-reference/rednote/note

- Endpoint: `POST https://api.primaryapi.com/v1/run/rednote.note`
- Category: Social · Platform: `rednote` · Kind: lookup · Status: live
- Price: 7 credits per call; up to 13 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=rednote.note`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `noteId` | string | yes |  | pattern: ^[0-9A-Za-z]{8,64}$ | RedNote (Xiaohongshu) note ID. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `noteId` | string |  |
| `type` | string \| null | Note media type (e.g. normal/image or video) |
| `title` | string \| null |  |
| `description` | string \| null | Note text |
| `image` | string \| null | Cover image URL |
| `authorUserId` | string \| null |  |
| `authorNickname` | string \| null |  |
| `authorRedId` | string \| null | Public RedNote number of the author |
| `authorImage` | string \| null |  |
| `likeCount` | integer \| null |  |
| `collectCount` | integer \| null |  |
| `commentCount` | integer \| null |  |
| `shareCount` | integer \| null |  |
| `createdUtc` | integer \| null | Publish time, UTC epoch seconds |
| `updatedUtc` | integer \| null | Last update time, UTC epoch seconds |
| `authorVerified` | boolean \| null |  |
| `location` | string \| null | Public IP-location label |
| `language` | string \| null |  |
| `url` | string \| null | Public note URL when the source returns one |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/rednote.note" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"noteId":"69e71b110000000022029e5e"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "noteId": "69e71b110000000022029e5e",
      "type": "string",
      "title": "string",
      "description": "string",
      "image": "string",
      "authorUserId": "string",
      "authorNickname": "string",
      "authorRedId": "string",
      "authorImage": "string",
      "likeCount": 0,
      "collectCount": 0,
      "commentCount": 0,
      "shareCount": 0,
      "createdUtc": 0,
      "updatedUtc": 0,
      "authorVerified": true,
      "location": "string",
      "language": "string",
      "url": "https://example.com"
    }
  },
  "provider": "PrimaryAPI",
  "credits": 7,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 7 credits per call
- Price ceiling: up to 13 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=rednote.note`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Primary; 97.9% of 53k runs). Fallback; both epoch seconds and milliseconds are accepted.

## Legal

Scraped from RedNote (Xiaohongshu), whose terms forbid scraping; payloads contain personal data of PRC users (PIPL) and can change without notice. Public, logged-out data only; use for lawful purposes and honour deletion requests.

