Rednote User Notes
Rednoteのユーザーノートとは、アカウントが公開している投稿で、テキスト、投稿者の帰属情報、メディア、公開日時、表示中のエンゲージメント数を含みます。これらのコンテンツとコンテキストのフィールドは、アカウント調査、投稿パターンの確認、フォーマットの比較、特定時点のパフォーマンス分析に活用できます。
Rednote User Notes API の主な機能
- 優先順位が明確な2種類のアカウント指定方法対応するRednoteユーザーの参照または user_id のどちらかを受け付けます。両方を指定した場合は、明示的な user_id が使用されます。
- アカウントのノートを1ページ分取得選択したアカウントについて、ソースへの1回のリクエストで返された公開ノートを取得します。ソースのカーソルや呼び出し側で指定する結果件数上限は公開していません。
- 正規化されたノートと投稿者のコンテキストノートID、公開URL、テキスト、投稿者情報、メディア参照、公開日時、取得日時を、一貫した PostItem 構造で返します。
- 表示中のエンゲージメントのスナップショット取得可能ないいね数・コメント数・シェア数・再生数を collected_at とともに保持し、期間を区切った比較に活用できます。
Rednote User Notes API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
url | 必須(いずれか1つ以上) | 空でないRednoteユーザーの参照で、解析後のホスト名が xiaohongshu.com、xhslink.com、またはそのいずれかのサブドメインである必要があります。パスのパターンは必須ではありません。URLに /user/<identifier> が含まれ、user_id が空欄の場合はその識別子が使用され、それ以外の場合は受け付けたURLがそのままアカウントの参照になります。 |
user_id | 必須(いずれか1つ以上) | ASCIIの英字、数字、コロン、アンダースコア、ハイフンからなる1〜256文字のRednoteユーザー識別子です。url または user_id を指定してください。両方を指定した場合は、明示的な user_id が優先されます。 |
Rednote User Notes API の使い方
対応するRednoteアカウントの識別情報を1つ送信して非同期タスクを追跡し、保存された正規化ノートレコードをページ送りで読み取ります。
- 受け付けられるホスト上の空でないRednoteユーザーURL、または有効な user_id のどちらかを用意します。不要なほうのフィールドは空欄のままにします。
- url または user_id を /v1/rednote/user-notes に POST し、返された task_id を保存します。
- タスクが成功するか失敗を報告するまで、/v1/tasks/{task_id} をポーリングします。
- data.results.items を読み取り、has_more が true の間は next_cursor をたどります。このカーソルは保存済みのレコードをページ送りするもので、Rednoteのソースページを追加で取得するものではありません。
curl -X POST "https://api.socq.ai/v1/rednote/user-notes" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"url\":\"$REDNOTE_USER_URL\"}"
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is trueRednote User Notes API の主なユースケース
- 公開アカウントの投稿一覧: ノートID、公開URL、テキスト、投稿者の帰属情報、公開日時を使い、返されたアカウントのスナップショットをカタログ化します。
- コンテンツ形式の確認: アカウントから返されたノート間で、取得可能な画像・動画の参照、サイズ、サムネイル、ノートのテキストを比較します。
- 投稿パターンの分析: ノートを published_at で並べ、テキストとメディアをあわせて確認し、スナップショット内でのアカウントの表示中の投稿構成を把握します。
- 特定時点のエンゲージメント比較: 表示中のいいね数・コメント数・シェア数・再生数を比較し、collected_at で各観測結果を取得日時に結び付けて管理します。
Rednote User Notes API 活用のヒント
- 安定した user_id をすでに持っている場合はそれを使用してください。url より優先され、2つのアカウント参照の間であいまいさが生じるのを防げます。
- url を送信する場合は、ホスト名が xiaohongshu.com または xhslink.com であることを検証してください。特定のパスのパターンは必須ではありません。
- 対応するURLに /user/<identifier> が含まれる場合、user_id が空欄であればその識別子が使用されるため、パスが目的のアカウントを指していることを確認してください。
- 送信内容に results_limit やソースのカーソルを追加しないでください。各タスクは1ページ分に対してソースへのリクエストを1回実行します。
- cursor と limit は、完了後の GET /v1/tasks/{task_id} でのみ使用してください。保存済み結果に対する limit はデフォルトが50で、1〜500を受け付けます。
- テキスト、投稿者フィールド、メディア、公開日時、ハッシュタグ、メンション、個々の指標は null になり得るものとして扱い、公開テキストは表示前にエスケープしてください。
関連API
Rednote User Notes API 以外に別の種類の公開Rednoteデータが必要な場合は、これらのAPIをご利用ください。