Reddit Search
Reddit検索の結果は、テキストクエリに一致した公開投稿で、タイトル、本文、投稿者、サブレディット情報、メディア、投稿日時、表示中の投票数とコメント数を含みます。これらのレコードは、トピックの発見、ソースの確認、期間を区切った調査、定義したクエリ間でのエンゲージメント比較に活用できます。
Reddit Search API の主な機能
- クエリによる投稿の発見空でないテキストクエリを1つ指定するだけで、投稿URLやサブレディットURLを用意せずに公開Reddit投稿を探せます。
- 投稿期間による絞り込み過去1時間、1日、1週間、1か月、1年に絞り込むか、all で対応する全期間を対象にできます。
- 上限付きの結果リクエストresults_limit を1〜2,000の範囲で設定し、クエリでリクエストする投稿の最大件数を指定します。
- 正規化された投稿と検索条件投稿内容、投稿者とコミュニティのフィールド、メディア、タイムスタンプ、表示中のエンゲージメント、検索時の入力を一貫したレコードで返します。
Reddit Search API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
query | 必須 | 必須。公開Reddit投稿を探すための空でないテキストです。 |
results_limit | 任意 | リクエストする投稿の最大件数です。デフォルトは100で、1〜2,000の整数を指定できます。 |
published_within | 任意 | 一致する投稿の投稿期間です。デフォルトは all で、hour、day、week、month、year、all を指定できます。 |
Reddit Search API の使い方
絞り込んだクエリに必要な期間と結果の上限を指定して送信し、完了した非同期タスクから正規化された投稿レコードを読み取ります。
- 空でないテキストの query を1つ用意し、任意で published_within の期間と results_limit を選びます。
- パラメータを /v1/reddit/search に POST し、返された task_id を保存します。
- タスクが成功するか失敗を返すまで /v1/tasks/{task_id} をポーリングします。
- data.results.items を読み取り、has_more が true の間は返された next_cursor を指定して続きを取得します。
curl -X POST "https://api.socq.ai/v1/reddit/search" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"machine learning","results_limit":100,"published_within":"month"}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is trueReddit Search API の主なユースケース
- トピックに関するディスカッションの発見: 投稿タイトル、本文、コミュニティ名、ソースURLを使って、特定のテーマに一致する公開ディスカッションを見つけます。
- ソースをたどれる調査データセット: 投稿ID、URL、投稿者、投稿日時、discovery_input を保持し、取得した各レコードをソースとクエリに結びつけたままにします。
- 期間別のエンゲージメント比較: published_within と created_at、collected_at、upvotes_count、comments_count、upvote_ratio を組み合わせて、範囲を区切った結果サンプルを比較します。
Reddit Search API 活用のヒント
- 一致した投稿の本文やコミュニティ情報を解釈しやすくするため、1つの調査課題を表す絞り込んだクエリを使用してください。
- 必要な期間に合わせて published_within を選択してください。投稿日での区切りによって関連する古い投稿が除外されてしまう場合は all のままにしてください。
- results_limit はリクエストの上限として扱い、保存されたすべての結果を読み取るには has_more が false になるまでタスク結果のカーソルをたどってください。
- 繰り返し検索した結果は投稿IDで重複を除外し、クエリと観測時点のコンテキストとして extra.discovery_input と collected_at を保持してください。
- 公開ソースで個別の値が省略される場合があるため、投稿者、メディア、コミュニティ、タイムスタンプ、エンゲージメントのフィールドは null を取りうるものとして扱ってください。
関連API
Reddit Search API 以外に別の種類の公開Redditデータが必要な場合は、これらのAPIをご利用ください。
- Reddit Posts API — 対応するReddit URLから、公開投稿のテキスト、投稿者、コミュニティ情報、メディア、タイムスタンプ、表示中のエンゲージメントを取得します。
- Reddit Comments API — 対応する投稿URLから、公開コメントのテキスト、投稿者、投稿と親コメントの参照、コミュニティ情報、タイムスタンプ、表示中のエンゲージメントを取得します。
- Reddit Subreddit Posts API — サブレディットのURLから公開投稿を探します。new・top・hotの並び順とサブレディットごとの取得上限を指定でき、正規化されたコミュニティ情報とエンゲージメント情報を返します。
- Reddit Subreddit Search API
- Reddit Trending Searches API — 入力なしで今日のRedditのトレンド検索を取得し、各検索語の順位とRedditの検索結果へのリンクを返します。
- Reddit Answers API — 質問を送ると、RedditのAIによる回答を、引用コメント、元の投稿、おすすめのサブレディットとともに返します。