Mastodon
  • Mastodonの使い方
    • Signing up for an account
    • Setting up your profile
    • Posting toots
    • Using the network features
    • Dealing with unwanted content
    • Promoting yourself and others
    • Set your preferences
    • その他の設定
    • Using Mastodon externally
    • Moving or leaving accounts
  • Mastodonの構築
    • マシンの準備
    • ソースからインストール
    • 環境設定
    • オプションのインストール
      • 全文検索
      • 秘匿サービス
      • シングルサインオン
    • セットアップを完了する
    • 開発者向けコマンドラインを利用する
    • 新しいバージョンへアップグレード
    • サーバのバックアップ
    • 新しいマシンへの移行
    • サーバーのスケールアップ
    • モデレーション
    • トラブルシューティング
  • アプリケーションの開発
    • Getting started with the API
    • Playing with public data
    • Obtaining client app access
    • ログイン
    • ガイドラインとベストプラクティス
    • ライブラリ等
  • コントリビューション
    • 技術的情報
    • 開発環境のセットアップ
    • ソースコードの構造
    • ルーティング
  • スペック
    • ActivityPub
    • WebFinger
    • Security
    • Microformats
    • OAuth
  • REST API
    • OAuthスコープ
  • API一覧
    • apps
      • oauth
    • accounts
      • bookmarks
      • favourites
      • mutes
      • blocks
      • domain_blocks
      • filters
      • reports
      • follow_requests
      • endorsements
      • featured_tags
      • preferences
      • suggestions
    • statuses
      • media
      • polls
      • scheduled_statuses
      • streaming
    • timelines
      • conversations
      • lists
      • markers
    • notifications
      • push
    • search
    • instance
      • trends
      • directory
      • custom_emojis
    • admin
    • proofs
    • oembed
  • APIエンティティ
    • Account
    • Activity
    • Admin::Account
    • Admin::Report
    • Application
    • Attachment
    • Card
    • Context
    • Conversation
    • Emoji
    • Error
    • FeaturedTag
    • Field
    • Filter
    • History
    • IdentityProof
    • Instance
    • List
    • Marker
    • Mention
    • Notification
    • Poll
    • Preferences
    • PushSubscription
    • Relationship
    • Report
    • Results
    • ScheduledStatus
    • Source
    • Status
    • Tag
    • Token

timelines

Read and view timelines of statuses.

get
Public timeline

https://mastodon.example/api/v1/timelines/public

戻り値: Array of Status
OAuth: Public. Requires app token + read:statuses if the instance has disabled public preview.
実装履歴:

  • 0.0.0 - 追加
  • 2.3.0 - 追加 only_media
  • 2.6.0 - add min_id
  • 3.0.0 - auth is required if public preview is disabled

リクエスト

クエリ
local
任意
boolean
Show only local statuses? Defaults to false.
only_media
任意
boolean
Show only statuses with media attached? Defaults to false.
max_id
任意
string
Return results older than this id
since_id
任意
string
Return results newer than this id
min_id
任意
string
Return results immediately newer than this id
limit
任意
integer
Maximum number of results to return. Defaults to 20.

レスポンス

200: Success

Sample API call with limit=2

[
  {
    "id": "103206804533200177",
    "created_at": "2019-11-26T23:27:31.000Z",
    ...
    "visibility": "public",
    ...
  },
  {
    "id": "103206804086086361",
    "created_at": "2019-11-26T23:27:32.000Z",
    ...
    "visibility": "public",
    ...
  }
]

get
Hashtag timeline

https://mastodon.example/api/v1/timelines/tag/:hashtag

View public statuses containing the given hashtag.

戻り値: Array of Status
OAuth: Public. Requires app token + read:statuses if the instance has disabled public preview.
実装履歴:

  • 0.0.0 - 追加
  • 2.3.0 - 追加 only_media
  • 2.6.0 - add min_id
  • 3.0.0 - auth is required if public preview is disabled

リクエスト

パス
:hashtag
必須
string
Content of a #hashtag, not including # symbol.
クエリ
local
任意
boolean
If true, return only local statuses. Defaults to false.
only_media
任意
boolean
If true, return only statuses with media attachments. Defaults to false.
max_id
任意
string
Return results older than this ID.
since_id
任意
string
Return results newer than this ID.
min_id
任意
string
Return results immediately newer than this ID.
limit
任意
integer
Maximum number of results to return. Defaults to 20.

レスポンス

200: Success

Sample timeline for the hashtag #cats and limit=2

[
  {
    "id": "103206185588894565",
    "created_at": "2019-11-26T20:50:15.866Z",
    ...
    "visibility": "public",
    ...
    "content": "<p><a href=\"https://mastodon.social/tags/cats\" class=\"mention hashtag\" rel=\"tag\">#<span>cats</span></a></p>",
    ...
    "tags": [
      {
        "name": "cats",
        "url": "https://mastodon.social/tags/cats"
      }
    ],
    ...
  },
  {
    "id": "103203659567597966",
    "created_at": "2019-11-26T10:07:49.000Z",
    ...
    "visibility": "public",
    ...
    "content": "<p>Caught on the hop. 😺 </p><p><a href=\"https://chaos.social/tags/Qualit%C3%A4tskatzen\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Qualitätskatzen</span></a> <a href=\"https://chaos.social/tags/cats\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>cats</span></a> <a href=\"https://chaos.social/tags/mastocats\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>mastocats</span></a> <a href=\"https://chaos.social/tags/catsofmastodon\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>catsofmastodon</span></a> <a href=\"https://chaos.social/tags/Greece\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Greece</span></a> <a href=\"https://chaos.social/tags/Agistri\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Agistri</span></a><br>(photo: <span class=\"h-card\"><a href=\"https://chaos.social/@kernpanik\" class=\"u-url mention\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">@<span>kernpanik</span></a></span> | license: CC BY-NC-SA 4.0)</p>",
    ...
    "tags": [
      {
        "name": "qualitätskatzen",
        "url": "https://mastodon.social/tags/qualit%C3%A4tskatzen"
      },
      {
        "name": "cats",
        "url": "https://mastodon.social/tags/cats"
      },
      {
        "name": "mastocats",
        "url": "https://mastodon.social/tags/mastocats"
      },
      {
        "name": "catsofmastodon",
        "url": "https://mastodon.social/tags/catsofmastodon"
      },
      {
        "name": "greece",
        "url": "https://mastodon.social/tags/greece"
      },
      {
        "name": "agistri",
        "url": "https://mastodon.social/tags/agistri"
      }
    ],
    ...
  }
]

get
Home timeline

https://mastodon.example/api/v1/timelines/home

View statuses from followed users.

戻り値: Array of Status
OAuth: User + read:statuses
実装履歴:

  • 0.0.0 - 追加
  • 2.6.0 - add min_id

リクエスト

ヘッダ
Authorization
必須
string
Bearer <user token>
クエリ
max_id
任意
string
Return results older than id
since_id
任意
string
Return results newer than id
min_id
任意
string
Return results immediately newer than id
limit
任意
string
Maximum number of results to return. Defaults to 20.
local
任意
boolean
Return only local statuses?

レスポンス

200: Success

Statuses in your home timeline will be returned

[
  {
    "id": "103206791453397862",
    "created_at": "2019-11-26T23:24:13.113Z",
    ...
  },
  ...
]

206:

Home feed is regenerating


401: Unauthorized

{
  "error": "The access token is invalid"
}

get
List timeline

https://mastodon.example/api/v1/timelines/list/:list_id

View statuses in the given list timeline.

戻り値: Array of Status
OAuth: User token + read:lists
実装履歴:

  • 2.1.0 - 追加
  • 2.6.0 - add min_id

リクエスト

パス
:list_id
必須
string
Local ID of the list in the database.
ヘッダ
Authorization
必須
string
Bearer <user token>
クエリ
max_id
任意
string
Return results older than this ID.
since_id
任意
string
Return results newer than this ID.
min_id
任意
string
Return results immediately newer than this ID.
limit
任意
integer
Maximum number of results to return. Defaults to 20.Return results older than this ID.

レスポンス

200: Success

Statuses in this list will be returned.

[
  {
    "id": "103206791453397862",
    "created_at": "2019-11-26T23:24:13.113Z",
    ...
  },
  ...
]

401: Unauthorized

{
  "error": "The access token is invalid"
}

get
\[DEPRECATED\] Direct timeline

/api/v1/timelines/direct

View statuses with a “direct” privacy, from your account or in your notifications.

戻り値: Array of Status
OAuth: User token + read:statuses
実装履歴:
x.x.x - 追加

  • 2.6.0 - add min_id. deprecated in favor of conversations
  • 3.0.0 - removed

リクエスト

ヘッダ
Authorization
必須
string
Bearer <user token>
クエリ
limit
任意
string
Maximum number of results to return. Defaults to 20.
max_id
任意
string
Return results older than ID
since_id
任意
string
Return results newer than ID
min_id
任意
string
Return results immediately newer than ID

レスポンス

200: Success

Statuses with direct visibility, authored by you or mentioning you. Statuses are not grouped by conversation, but are simply returned in chronological order.

[
  {
    "id": "103206185588894565",
    "created_at": "2019-11-26T20:50:15.866Z",
    ...
    "visibility": "direct",
    ...
  },
  ...
]

401: Unauthorized

{
  "error": "The access token is invalid"
}

最終更新 May 17, 2020 · このページを改善する
他の言語: English

Merch

Tシャツとステッカー(英語)

Mastodonに参加しよう · ブログ · ·

ソースコード · CC BY-SA 4.0 · インプリント