• About Cosense
  • Help
  • Log in
Cosense研究会
Scrapbox REST APIの一覧
ページの情報を取得する
api/pages/:projectname/:pagetitle
api/pages/:projectname/:pagetitle/text
api/pages/:projectname/:pagetitle/icon
api/pages/:projectname/search/titles
api/code/:projectname/:pagetitle/:filename
api/table/:projectname/:pagetitle/:filename.csv
api/page-snapshots/:projectname/:pageid
api/page-snapshots/:projectname/:pageid/:timestampid
api/commits/:projectname/:pageid
api/deleted-pages/:projectname/:pageid
全文検索
api/pages/:projectname/search/query
api/projects/search/query
api/projects/search/watch-list
Projectの情報を取得する
api/pages/:projectname
api/projects/:projectname
api/stream/:projectname/
api/feed/:projectname
api/projects/:projectname/notifications
api/projects/:projectname/invitations
api/project-backup/:projectname/list
api/project-backup/:projectname/:backupId.json
api/page-data/export/:projectname.json
Userの情報を取得する
api/users/me
api/projects
api/gcs/:projectname/usage
Scrapboxの内部処理用
api/settings
api/google-map/static-map
Googleマップの埋め込みに使う画像を取得する

要CSRF token
api/page-data/import/:projectname.json
logout
不明
https://scrapbox.io/api/page-data/import-finish/:projectname.json
おそらくページをインポートしたあと、server側で各種計算が終了するまで待機するためのAPIではないか?

#API

Related
  • Sort by
  • Related
  • Modified
  • Created
  • Last visited
  • Most linked
  • Page rank
  • Title
  • Links
  • api/pages/:projectname/search/titles
    プロジェクト内のページ一覧と、各ページの[リンク]情報が取得できる。`https://scrapbox.io/api/pages/:projectname/search/titles`[api/pages/:projectname]と違ってページの作成日時やdescriptionなどは取得できない作成日時が古い順に1000件づつ取得できる。応答ヘッダの`X-Following-Id`に基づいて`titles?followingId=xxxx`をリクエストすることで続きを取得できる。
  • api/page-snapshots/:projectname/:pageid
    [page history]の表示に使用するデータ`https://scrapbox.io/api/page-snapshots/:projectname/:pageid``:pageid`は[scrapbox.Page.id]で取得できる[Scrapbox REST APIの一覧#5f9217de1280f00000950627]も同じ以前は全てのsnapshotsが含まれたJSONが帰ってきたが、現在は[api/page-snapshots/:projectname/:pageid/:timestampid]にわたす`timestampid`が含まれたJSONが返ってくるようになった
  • api/page-snapshots/:projectname/:pageid/:timestampid
    特定の[page history]を取得する`https://scrapbox.io/api/page-snapshots/:projectname/:pageid/:timestampid``:pageid`は[scrapbox.Page.id]で取得できる`:timestampid`は[api/page-snapshots/:projectname/:pageid]から取得する応答の型
  • api/users/me
    自分のuser情報`https://scrapbox.io/api/users/me`クリックすると自分の情報が表示される→ [https://scrapbox.io/api/users/me]応答の型`type UserResponse = {`
  • API
    Scrapbox の Web API を指す場合が多い。[/help-jp/API][Scrapbox REST APIの一覧]または[UserScriptから使えるscrapboxのobject]
  • logout
    Scrapboxから[ログアウト]をすることができるもう少し正確に言うと、[connect.sid]を破棄することができる(破棄すると今後一切使用できなくなる)POST: `https://scrapbox.io/logout`parameters`cookie`
  • api/projects
    自分が所属しているprojectの情報`https://scrapbox.io/api/projects`parameters`ids`取得したいprojectのid
  • api/pages/:projectname/search/query
    プロジェクト内ページ全文検索`https://scrapbox.io/api/pages/:projectname/search/query`e.g. https://scrapbox.io/api/pages/scrapboxlab/search/query?q=scrapbox%20-java%20gyazoparameters`q`
  • api/project-backup/:projectname/:backupId.json
    [Auto Project Backup]にある指定のbackup json fileを取得する`https://scrapbox.io/api/project-backup/:projectname/:backupId.json``:backupId`に`BackupListResponse.backups[].id`を指定する末尾に`.json`をつける必要があるownerもしくはadmin権限を持っているUserのみ取得できる
  • api/projects/:projectname
    projectの情報`https://scrapbox.io/api/projects/:projectname`応答の型`type ProjectResponse = {``id: string;`
  • api/page-data/import/:projectname.json
    [Scrapboxのインポート機能]で使われているAPI使い方POSTで叩く要求ヘッダー`Accept`
  • api/deleted-pages/:projectname/:pageid
    `https://scrapbox.io/api/deleted-pages/:projectname/:pageid`削除されたページを取得するAPI削除されたページのidは[api/stream/:projectname/]で取得できる
  • api/pages/:projectname
    プロジェクト内のページ情報`https://scrapbox.io/api/pages/:projectname`parameters`limit`取得するページ情報の最大数
  • api/commits/:projectname/:pageid
    ページの[コミットログ]`https://scrapbox.io/api/commits/:projectname/:pageid``:pageid`は[scrapbox.Page.id]で取得できる直近のcommitしか取得できない最終更新日からしばらく経つと消える
  • api/stream/:projectname/
    projectの[Stream]`https://scrapbox.io/api/stream/:projectname/`応答の型from [Scrapbox REST APIの一覧]
  • api/code/:projectname/:pagetitle/:filename
    指定した[コードブロック]のテキストを取得する`https://scrapbox.io/api/code/:projectname/:pagetitle/:filename``:filename`のところには[コードブロック記法]で指定したファイル名が入る。from [Scrapbox REST APIの一覧]
  • api/settings
    scrapbox.ioの設定情報API keyとかが含まれている`https://scrapbox.io/api/settings`from [Scrapbox REST APIの一覧]
  • api/gcs/:projectname/usage
    [ファイルのアップロード上限]などの情報を取得する`https://scrapbox.io/api/gcs/:projectname/usage``:projectname`には自分の参加しているprojectを指定するfree userの場合は、どのprojectを指定しても同じ結果が返ってくる応答の型
  • api/projects/:projectname/notifications
    projectに登録されているSlack通知のURLリスト`https://scrapbox.io/api/projects/:projectname/notifications`ownerもしくはadmin権限を持っているUserのみ取得できる応答の型from [Scrapbox REST APIの一覧]
  • api/feed/:projectname
    [プロジェクトのRSS]`https://scrapbox.io/api/feed/:projectname`from [Scrapbox REST APIの一覧]
  • api/projects/search/query
    [project横断検索]`https://scrapbox.io/api/projects/search/query`自分が所属しているprojectの中から、検索語句を含むprojectのリストを返すparameter`q`
  • api/pages/:projectname/:pagetitle/text
    指定したページのプレーンなテキスト。ブラケットなどはそのまま維持。`https://scrapbox.io/api/pages/$projectname/$pagetitle/text`from [Scrapbox REST APIの一覧]
  • api/table/:projectname/:pagetitle/:filename.csv
    指定した[テーブル記法]で書いた[テーブル]([表])。`https://scrapbox.io/api/table/:projectname/:pagetitle/:filename.csv``:filename`のところにはテーブル記法で指定したテーブルの名前が入るテーブル記法はタブ区切りだったが、APIではコンマ区切り(CSV)になるので、データ中にコンマ`,`が入るデータの取り扱いには注意が必要。
  • api/project-backup/:projectname/list
    [Auto Project Backup]のリストを取得する`https://scrapbox.io/api/project-backup/$projectname/list`ownerもしくはadmin権限を持っているUserのみ取得できる応答の型from [Scrapbox REST APIの一覧]
  • api/projects/:projectname/invitations
    projectの[招待リンク]を取得する`https://scrapbox.io/api/projects/:projectname/invitations`ownerもしくはadmin権限を持っているUserのみ取得できる応答の型from [Scrapbox REST APIの一覧]
  • api/pages/:projectname/:pagetitle
    `https://scrapbox.io/api/pages/:projectname/:pagetitle`個別のページ情報。[json]parameters`followRename`[ページが無い場合、アクセス履歴から変更先のタイトルを探してリダイレクトする機能 https://scrapbox.io/shokai/%E6%B1%8E%E7%94%A8%E7%9A%84%E3%81%AA%E5%B0%8F%E3%81%95%E3%81%AA%E6%A9%9F%E8%83%BD#58c519ee97c2910000e9a620]の有効化
  • CSRF token
    [/villagepump/X-CSRF-TOKEN]
  • api/projects/search/watch-list
    [Watch List]から[project横断検索]するAPI`https://scrapbox.io/api/projects/search/watch-list`parameters`q`: 検索ワード`ids`: 検索対象のproject id
  • api/page-data/export/:projectname.json
    [Scrapboxのプロジェクトをエクスポートする]API`https://scrapbox.io/api/page-data/export/:projectname.json`2022-01-02頃以降APIがPOSTからGETに変更されたURL parameter`metadata`
  • api/pages/:projectname/:pagetitle/icon
    `https://scrapbox.io/api/pages/$projectname/$pagetitle/icon`そのページの[アイコン]。
  • Googleマップの埋め込み
  • api/pages/:projectname/:pagetitle
  • ページ取得APIで返ってくるもの
    ↓はhttps://scrapbox.io/api/pages/help-jp/api の取得結果#api/pages/:projectname/:pagetitle
  • api/pages/:projectname/:pagetitle/icon
  • APIでページのアイコンを引っ張ってくる
    [api/pages/:projectname/:pagetitle/icon]を使うたとえば、/api/pages/scrapboxlab/rashita/iconのように書く。Scrapbox内なら
  • api/code/:projectname/:pagetitle/:filename
  • コードブロック
    [コードブロック記法]。[Scrapbox記法]の一つ。[/help-jp/コードブロック]`code:hogehoge`のように書くことでコードブロック(複数行)が生成できる。シンタックスハイライトされる。
  • api/commits/:projectname/:pageid
  • コミットログを取得する
    以下の[ブックマークレット]を実行するとページの[コミットログ]を取得できる対象のページ上で実行することmemberでないprojectのページの[コミットログ]は取得できない#api/commits/:projectname/:pageid に[scrapbox.Page.id]を渡して使う[/masui/Scrapboxの編集履歴ブックマークレット]を使うと、見やすい[コミットログ]を得ることが出来る
  • api/stream/:projectname/
  • Stream
  • Googleマップの埋め込み
  • Scrapboxで地図を埋め込む時にピンが出なくてキレたので原因究明した
  • API
  • UserScriptから使えるscrapboxのobject
    [UserScript]から使える[/icons/Scrapbox.icon]の[API]データ系[scrapbox.Page.title]現在開いているページのタイトル[scrapbox.Page.lines]
  • 非公開projectのAPIを叩く
    ログインしているweb browserから[非公開プロジェクト]の[API]を叩く公開projectのAPIと同様に使える[connect.sid]はweb browserが自動的に付けてくれるログインしていないweb browserや、server上のprogramから叩くCookieに[connect.sid]を明示的に付けて渡す必要がある
  • cURL
    [URL]を元にファイルをやりとりするコマンドラインツールです。CURLじゃなくてcURLScrapbox の [API] を叩いてみる。API を叩いてこのページを表示させる。[jq]と組み合わせて使うといいらしい。
  • json
    噂によると、気味の悪い拡張子。[「JSONという気味の悪い拡張子」“誤訳”で物議 東洋経済オンラインの記事修正「原文とかい離していた」 - ITmedia NEWS https://www.itmedia.co.jp/news/articles/1806/08/news065.html][JavaScript]用に開発されたらしいが、他のプログラミング言語でも使える。最近のwebのデータ処理を覗いているとけっこう見かける。
  • ページ単位でエクスポートしたい
    現状[アイデア段階]。プロジェクト全体ではなく、ページ表示の状況で、そのページの中身と、下に表示される関連ページを含めたひとかたまりを[エクスポート]したい。なんならそれを[OPML]形式にしてもいい。Scrapboxから直接アウトプット、というのではなく、さらなる加工を加えてからのアウトプットを狙っている(だからアウトライナーに読み込ませる)たぶん下のツイートも同じような狙いがありそう
  • New Links
  • api/google-map/static-map
  • Created by 倉下忠憲倉下忠憲
  • Updated by takkertakker
  • with sawachinsawachinみじんこみじんこ
  • Views: 10173
  • Page rank: 39.59
  • Copy link
  • Copy readable link
  • Start presentation
  • Hide dots
Scrapbox REST APIの一覧
ページの情報を取得する
api/pages/:projectname/:pagetitle
api/pages/:projectname/:pagetitle/text
api/pages/:projectname/:pagetitle/icon
api/pages/:projectname/search/titles
api/code/:projectname/:pagetitle/:filename
api/table/:projectname/:pagetitle/:filename.csv
api/page-snapshots/:projectname/:pageid
api/page-snapshots/:projectname/:pageid/:timestampid
api/commits/:projectname/:pageid
api/deleted-pages/:projectname/:pageid
全文検索
api/pages/:projectname/search/query
api/projects/search/query
api/projects/search/watch-list
Projectの情報を取得する
api/pages/:projectname
api/projects/:projectname
api/stream/:projectname/
api/feed/:projectname
api/projects/:projectname/notifications
api/projects/:projectname/invitations
api/project-backup/:projectname/list
api/project-backup/:projectname/:backupId.json
api/page-data/export/:projectname.json
Userの情報を取得する
api/users/me
api/projects
api/gcs/:projectname/usage
Scrapboxの内部処理用
api/settings
api/google-map/static-map
Googleマップの埋め込みに使う画像を取得する
要CSRF token
api/page-data/import/:projectname.json
logout
不明
https://scrapbox.io/api/page-data/import-finish/:projectname.json
おそらくページをインポートしたあと、server側で各種計算が終了するまで待機するためのAPIではないか?
#API