note の API を利用することで、note 上のさまざまなデータをプログラムから取得したり、操作したりすることができます。以下では、主な API をカテゴリごとに整理して紹介します。
すべての API のベース URL は次のとおりです：
記事関連の API
閲覧
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| キーワードを指定して記事を検索 |
/v3/searches?context=note&q=北海道&size=1&start=0 |
GET |
v3 |
| 記事の詳細 |
/v3/notes/n4f0c7b884789 |
GET |
v3 |
投稿
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| 下書き状態の記事の投稿 |
/v1/text_notes/draft_save?id=xxxxxxx |
POST |
v1 |
コメント
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| 記事へのコメント一覧 |
/v1/note/35890427/comments |
GET |
v1 |
| 記事へのコメント投稿 |
/v1/note/35890427/comments |
POST |
v1 |
スキ
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| 記事のスキ一覧 |
/v3/notes/n04b99fa6a237/likes |
GET |
v3 |
| 記事にスキをする |
/v3/notes/n5ed3a575042e/likes |
POST |
v3 |
| 記事のスキを削除する |
/v3/notes/n5ed3a575042e/likes |
DELETE |
v3 |
ユーザー関連の API
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| ユーザーの記事一覧 |
/v2/creators/info/contents?kind=note&page=1 |
GET |
v2 |
| ユーザー一覧 |
/v2/users |
GET |
v2 |
| キーワードを指定してユーザーを検索 |
/v3/searches?context=user&q=北海道&size=1&start=0 |
GET |
v3 |
| ユーザーの詳細 |
/v2/creators/princess_11 |
GET |
v2 |
| ユーザーのフォロー一覧 |
/v1/followings/princess_11/list |
GET |
v1 |
| ユーザーをフォローする |
/v3/users/918783da3b49c2b5dcb7f316e3801a4d/following |
POST |
v3 |
| ユーザーのフォロワー一覧 |
/v1/followers/princess_11/list |
GET |
v1 |
マガジン関連の API
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| キーワードを指定してマガジンを検索 |
/v3/searches?context=magazine&q=北海道&size=1&start=0 |
GET |
v3 |
| マガジンの詳細 |
/v1/magazines/m75081e161aeb |
GET |
v1 |
| マガジンを登録 |
/v1/our/magazines/m35f15388de82/notes |
POST |
v1 |
| マガジンから記事を削除 |
/v1/our/magazines/m35f15388de82/notes/n1ad3ea518357 |
DELETE |
v1 |
カテゴリー関連の API
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| カテゴリー一覧 |
/v2/categories |
GET |
v2 |
| カテゴリーに含まれる記事一覧 |
/v1/categories/tech?note_intro_only=true&sort=new&page=1 |
GET |
v1 |
ハッシュタグ関連の API
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| ハッシュタグ一覧 |
/v2/hashtags |
GET |
v2 |
| ハッシュタグの詳細 |
/v2/hashtags/エッセイ |
GET |
v2 |
その他の API
| タイトル（説明） |
URL のパス |
HTTP メソッド |
バージョン |
| 検索ワード履歴 |
/v2/search_histories |
GET |
v2 |
| コンテスト一覧 |
/v2/contests |
GET |
v2 |
| 通知件数取得 |
/v3/notice_counts |
GET |
v3 |
| ダッシュボードの PV 取得 |
/v1/stats/pv?filter=all&page=1&sort=pv |
GET |
v1 |
たとえば、記事を検索したい場合は以下のように API を利用します。
curl -X GET "https://note.com/api/v3/searches?context=user&q=北海道&size=1&start=0"
このように、note の API を活用して、さまざまな操作をプログラムから実行できるようになります。詳細なドキュメントや使い方については、note の公式 API ドキュメントを参照してください。