# RedNote (Xiaohongshu) User Notes (`rednote.user_notes`)

Notes posted by a RedNote (Xiaohongshu) user, with cover, engagement counts and timestamps, cursor-paged.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/rednote.user_notes`
- Category: Social · Platform: `rednote` · Kind: list · Status: live
- Price: 13 credits per call; up to 126 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.user_notes`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `userId` | string | yes |  | max 300 chars | RedNote (Xiaohongshu) user ID (24-character hex, e.g. "67c25fdc000000000a03dae1"); a xiaohongshu.com/user/profile/<id> URL also works. |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

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 |
|---|---|---|
| `notes` | object[] |  |
| `notes[].noteId` | string |  |
| `notes[].url` | string |  |
| `notes[].type` | string \| null | normal (image note) \| video |
| `notes[].title` | string \| null |  |
| `notes[].description` | string \| null |  |
| `notes[].image` | string \| null | Cover image URL |
| `notes[].authorUserId` | string \| null |  |
| `notes[].authorNickname` | string \| null |  |
| `notes[].authorImage` | string \| null |  |
| `notes[].likeCount` | integer \| null |  |
| `notes[].collectCount` | integer \| null |  |
| `notes[].commentCount` | integer \| null |  |
| `notes[].shareCount` | integer \| null |  |
| `notes[].createdUtc` | integer \| null | UTC epoch seconds |
| `notes[].updatedUtc` | integer \| null | UTC epoch seconds |
| `hasMore` | boolean \| null | true when another page exists |
| `nextCursor` | string \| null | Pass back as `cursor` for the next page; null at the end |

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.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

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

## 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": {
      "notes": [
        {
          "noteId": "string",
          "url": "https://example.com",
          "type": "string",
          "title": "string",
          "description": "string",
          "image": "string",
          "authorUserId": "string",
          "authorNickname": "string",
          "authorImage": "string",
          "likeCount": 0,
          "collectCount": 0,
          "commentCount": 0,
          "shareCount": 0,
          "createdUtc": 0,
          "updatedUtc": 0
        }
      ],
      "hasMore": true,
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 13,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 13 credits per call
- Price ceiling: up to 126 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.user_notes`

## 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.

