Reddit App API
JA

Redditの過去のデータ · JSON API

アプリにRedditの議論検索を追加

Redditのアーカイブデータを、Web・モバイルアプリへの議論検索の組み込みに活用できます。 この例では、最大3件のレコードを含む1ページを取得します。

GETJSONHTTPS
リクエストの構成
リクエストの構成/v1/searchidkindcreated_utctextr/SideProject
/v1/searchSideProject
01結果が空の場合も、成功したリクエスト1回につき1クレジットを消費します。
100ページと取得件数
$1 / 1,000リクエスト単位の料金
01 / Reddit App API

Reddit App API — クエリから使えるレコードへ

小さな選択範囲から始め、次の処理に必要な項目とリクエスト条件を保存してから、自分のアプリケーションで結果を処理します。

01

レコードを選択

/v1/searchにq=search・subreddit=SideProjectを指定し、まずlimit=3で応答を確認します。

02

応答を準備

APIキーはバックエンドに保管し、ブラウザやモバイルアプリには必要な応答データだけを渡します。

03

プロジェクトに活用

permalinkがあればメモと一緒に出典として保存します。ただしリンク先が後で閲覧できなくなる場合があります。

用途に合わせて変更できるリクエスト

GET /v1/search · cURL
curl --get --fail-with-body 'https://api.redditapp.com/v1/search' \
  -H "Authorization: Bearer ${REDDIT_API_KEY}" \
  --data-urlencode 'q=search' \
  --data-urlencode 'subreddit=SideProject' \
  --data-urlencode 'limit=3' \
  --data-urlencode 'page=1'

この例では、最大3件のレコードを含む1ページを取得します。

APIのベースURLhttps://api.redditapp.com/v1

リクエストごとに取得範囲を設定

テキストとコミュニティ

qにsubredditまたはauthorを組み合わせ、対象を絞り込みます。

UTCの日付範囲

fromとtoをYYYY-MM-DD形式で指定します。終了日はUTCのその日全体を含みます。

ページと取得件数

limitとpageを指定し、結果と一緒にページ情報を保存します。

成功したリクエストごとの料金

結果が空の場合も、成功したリクエスト1回につき1クレジットを消費します。

成功した1,000リクエストにつき$1

最低チャージ額:$50 · 50,000クレジット

FAQ / 08

連携を始める前に

Reddit App APIとは何ですか?

Reddit App APIは、Redditの過去のレコードを取得する独立したJSON APIです。検索・投稿・コメント・個別レコード・subreddit検索に対応する読み取り専用ルートを提供します。Redditが運営するサービスではなく、提携関係もありません。Redditのアーカイブデータを、Web・モバイルアプリへの議論検索の組み込みに活用できます。 この例では、最大3件のレコードを含む1ページを取得します。

APIキーはどのように取得しますか?

このサイトでメールアドレスとパスワードを使って登録します。支払いが必要になる前にキーが表示されますが、表示は1回だけなので安全に保存してください。サーバーからX-API-KeyまたはAuthorization: Bearerで送信します。キーを再発行すると以前のキーは無効になり、利用中のクライアント設定も更新する必要があります。

Reddit App APIの料金はいくらですか?

料金は成功した1,000リクエストにつき$1です。最低チャージは$50で50,000クレジットになります。一致するレコードがなくても、成功したリクエストは1クレジットを消費します。無効なリクエストは課金対象外です。上流側の障害では返金処理が始まりますが照合が必要な場合があり、タイムアウトだけでは最終的な課金結果は判断できません。

Redditのレコードにはどの検索フィルターを使えますか?

解析済みテキスト検索のqを、subreddit・author・kind・from・to・min_scoreと組み合わせられます。複数の単語はAND条件で処理され、意味検索や任意のDSLには対応していません。日付はUTCのYYYY-MM-DD形式で、toは指定日の終わりまで含みます。最初はリファレンスに記載されたパラメータを使用してください。

Reddit App APIはRedditのリアルタイムデータを提供しますか?

いいえ。対象は過去のアーカイブで、Redditのライブフィードではありません。投稿・投票・プライベートメッセージ送信・Reddit OAuth操作は行えません。公開ルート/v1/statusはサービスの対象範囲を説明するもので、アーカイブの稼働状態、完全な収録範囲、元のRedditページが現在閲覧できることを証明するものではありません。

検索に一致する全レコードをエクスポートできますか?

必ずしもできません。1リクエストで最大100件、pageは1〜100です。totalはpagination.relationと一緒に読み、正確な値・下限・不明を区別してください。並び順はアーカイブ順で、日時順や関連度順の保証はありません。取得可能な最後のページまで読んでも、保存した標本がすべての一致を含むとは限りません。

同じキーを別のドメインでも使えますか?

いいえ。アカウント・APIキー・クレジット残高はサイトごとに分離されています。このドメインで発行されたキーを、対応するHTTPS APIホストに送ってください。キーはサーバー設定に保管し、ブラウザのJavaScript・公開リポジトリ・共有ログには置かないでください。別サイトのキーを、このサイトのアカウントの代わりには使用できません。

最初にどのリクエストを試すべきですか?

/v1/searchにq=search・subreddit=SideProject・limit=3・page=1を指定して始めてください。小さい応答で項目を確認してから、取込処理や画面の実装を進められます。成功時は空の結果も1クレジットです。トピックとコミュニティは目的に合わせて変更してください。この例は固定件数の応答を約束するものではありません。

API / Reddit App API

最初のリクエストを作る

アカウントを作成し、キーを保存して、目的に合わせて例を調整してください。

APIキーを取得