2024年版 note API 非公式一覧表

noteのAPI概要と利用方法

noteのAPIを利用することで、note上のさまざまなデータをプログラムから取得したり、操作したりすることができます。以下では、主なAPIをカテゴリごとに整理して紹介します。

参考資料でも書いていますが、APIのエンドポイントの一覧を把握するにはテーブルで書く事が出来る私のサイトの方が分かりやすいです

ベースURL

すべてのAPIのベースURLは次のとおりです：

https://note.com/api

記事関連のAPI

キーワードを指定して記事を検索

• URLのパス： `/v3/searches?context=user&q=北海道&size=1&start=0`

• HTTPメソッド： GET

• バージョン： v3

記事の詳細

• URLのパス： `/v3/notes/n4f0c7b884789`

• HTTPメソッド： GET

• バージョン： v3

下書き状態の記事の投稿

• URLのパス： `/v1/text_notes/draft_save?id=xxxxxxx`

• HTTPメソッド： POST

• バージョン： v1

記事へのコメント一覧

• URLのパス： `/v1/note/35890427/comments`

• HTTPメソッド： GET

• バージョン： v1

記事へのコメント投稿

• URLのパス： `/v1/note/35890427/comments`

• HTTPメソッド： POST

• バージョン： v1

記事のスキ一覧

• URLのパス： `/v3/notes/n04b99fa6a237/likes`

• HTTPメソッド： GET

• バージョン： v3

記事にスキをする

• URLのパス： `/v3/notes/n5ed3a575042e/likes`

• HTTPメソッド： POST

• バージョン： v3

記事のスキを削除する

• URLのパス： `/v3/notes/n5ed3a575042e/likes`

• HTTPメソッド： DELETE

• バージョン： v3

ユーザー関連のAPI

ユーザーの記事一覧

• URLのパス： `/v2/creators/info/contents?kind=note&page=1`

• HTTPメソッド： GET

• バージョン： v2

ユーザー一覧

• URLのパス： `/v2/users`

• HTTPメソッド： GET

• バージョン： v2

キーワードを指定してユーザーを検索

• URLのパス： `/v3/searches?context=user&q=北海道&size=1&start=0`

• HTTPメソッド： GET

• バージョン： v3

ユーザーの詳細

• URLのパス： `/v2/creators/princess_11`

• HTTPメソッド： GET

• バージョン： v2

ユーザーのフォロー一覧

• URLのパス： `/v1/followings/princess_11/list`

• HTTPメソッド： GET

• バージョン： v1

ユーザーをフォローする

• URLのパス： `/v3/users/918783da3b49c2b5dcb7f316e3801a4d/following`

• HTTPメソッド： POST

• バージョン： v3

ユーザーのフォロワー一覧

• URLのパス： `/v1/followers/princess_11/list`

• HTTPメソッド： GET

• バージョン： v1

マガジン関連のAPI

キーワードを指定してマガジンを検索

• URLのパス： `/v3/searches?context=magazine&q=北海道&size=1&start=0`

• HTTPメソッド： GET

• バージョン： v3

マガジンの詳細

• URLのパス： `/v1/magazines/m75081e161aeb`

• HTTPメソッド： GET

• バージョン： v1

マガジンを登録

• URLのパス： `/v1/our/magazines/m35f15388de82/notes`

• HTTPメソッド： POST

• バージョン： v1

マガジンから記事を削除

• URLのパス： `/v1/our/magazines/m35f15388de82/notes/n1ad3ea518357`

• HTTPメソッド： DELETE

• バージョン： v1

カテゴリー関連のAPI

カテゴリー一覧

• URLのパス： `/v2/categories`

• HTTPメソッド： GET

• バージョン： v2

カテゴリーに含まれる記事一覧

• URLのパス： `/v1/categories/tech?note_intro_only=true&sort=new&page=1`

• HTTPメソッド： GET

• バージョン： v1

ハッシュタグ関連のAPI

ハッシュタグ一覧

• URLのパス： `/v2/hashtags`

• HTTPメソッド： GET

• バージョン： v2

ハッシュタグの詳細

• URLのパス： `/v2/hashtags/エッセイ`

• HTTPメソッド： GET

• バージョン： v2

その他のAPI

検索ワード履歴

• URLのパス： `/v2/search_histories`

• HTTPメソッド： GET

• バージョン： v2

コンテスト一覧

• URLのパス： `/v2/contests`

• HTTPメソッド： GET

• バージョン： v2

通知件数取得

• URLのパス： `/v3/notice_counts`

• HTTPメソッド： GET

• バージョン： v3

ダッシュボードのPV取得

• URLのパス： `/v1/stats/pv?filter=all&page=1&sort=pv`

• HTTPメソッド： GET

• バージョン： v1

APIの利用例

例えば、記事を検索したい場合は以下のようにAPIを利用します。

curl -X GET "https://note.com/api/v3/searches?context=user&q=北海道&size=1&start=0"

このように、noteのAPIを活用して、さまざまな操作をプログラムから実行できるようになります。詳細なドキュメントや使い方については、noteの公式APIドキュメントを参照してください。

参考資料

認証方法やヘッダーの最新の指定方法などは以下の記事を参考にしてください。

実を言うと、テーブルが使えたので noteの記事より個人的に自分のサイトの方が見やすいです

2024年版 note API 非公式一覧表

2023年版