go-mastodon

Usage

There are three ways to authenticate users. Fully working examples can be found in the examples directory.

User Credentials

This method is the simplest and allows you to use an application registered in your account to interact with the Mastodon API on your behalf.

Create an application on Mastodon by navigating to: Preferences > Development > New Application
Select the necessary scopes

Working example: examples/user-credentials/main.go

Public Application

Public applications use application tokens and have limited access to the API, allowing access only to public data.

Learn more at: Mastodon docs

Working example: examples/public-application/main.go

Application with Client Credentials (OAuth)

This option allows you to create an application that can interact with the Mastodon API on behalf of a user. It registers the application and requests user authorization to obtain an access token.

Learn more at: Mastodon docs

Working example: examples/user-oauth-authorization/main.go

Status of implementations

[x] GET /api/v1/accounts/:id
[x] GET /api/v1/accounts/verify_credentials
[x] PATCH /api/v1/accounts/update_credentials
[x] GET /api/v1/accounts/:id/followers
[x] GET /api/v1/accounts/:id/following
[x] GET /api/v1/accounts/:id/statuses
[x] POST /api/v1/accounts/:id/follow
[x] POST /api/v1/accounts/:id/unfollow
[x] GET /api/v1/accounts/:id/block
[x] GET /api/v1/accounts/:id/unblock
[x] GET /api/v1/accounts/:id/mute
[x] GET /api/v1/accounts/:id/unmute
[x] GET /api/v1/accounts/:id/lists
[x] GET /api/v1/accounts/relationships
[x] GET /api/v1/accounts/search
[x] GET /api/v1/apps/verify_credentials
[x] GET /api/v1/bookmarks
[x] POST /api/v1/apps
[x] GET /api/v1/blocks
[x] GET /api/v1/conversations
[x] DELETE /api/v1/conversations/:id
[x] POST /api/v1/conversations/:id/read
[x] GET /api/v1/favourites
[x] GET /api/v1/filters
[x] POST /api/v1/filters
[x] GET /api/v1/filters/:id
[x] PUT /api/v1/filters/:id
[x] DELETE /api/v1/filters/:id
[x] GET /api/v1/follow_requests
[x] POST /api/v1/follow_requests/:id/authorize
[x] POST /api/v1/follow_requests/:id/reject
[x] GET /api/v1/followed_tags
[x] POST /api/v1/follows
[x] GET /api/v1/instance
[x] GET /api/v1/instance/activity
[x] GET /api/v1/instance/peers
[x] GET /api/v1/lists
[x] GET /api/v1/lists/:id/accounts
[x] GET /api/v1/lists/:id
[x] POST /api/v1/lists
[x] PUT /api/v1/lists/:id
[x] DELETE /api/v1/lists/:id
[x] POST /api/v1/lists/:id/accounts
[x] DELETE /api/v1/lists/:id/accounts
[x] POST /api/v1/media
[x] GET /api/v1/mutes
[x] GET /api/v1/notifications
[x] GET /api/v1/notifications/:id
[x] POST /api/v1/notifications/:id/dismiss
[x] POST /api/v1/notifications/clear
[x] POST /api/v1/push/subscription
[x] GET /api/v1/push/subscription
[x] PUT /api/v1/push/subscription
[x] DELETE /api/v1/push/subscription
[x] GET /api/v1/reports
[x] POST /api/v1/reports
[x] GET /api/v2/search
[x] GET /api/v1/statuses/:id
[x] GET /api/v1/statuses/:id/context
[x] GET /api/v1/statuses/:id/card
[x] GET /api/v1/statuses/:id/history
[x] GET /api/v1/statuses/:id/reblogged_by
[x] GET /api/v1/statuses/:id/source
[x] GET /api/v1/statuses/:id/favourited_by
[x] POST /api/v1/statuses
[x] PUT /api/v1/statuses/:id
[x] DELETE /api/v1/statuses/:id
[x] POST /api/v1/statuses/:id/reblog
[x] POST /api/v1/statuses/:id/unreblog
[x] POST /api/v1/statuses/:id/favourite
[x] POST /api/v1/statuses/:id/unfavourite
[x] POST /api/v1/statuses/:id/bookmark
[x] POST /api/v1/statuses/:id/unbookmark
[x] GET /api/v1/timelines/home
[x] GET /api/v1/timelines/public
[x] GET /api/v1/timelines/tag/:hashtag
[x] GET /api/v1/timelines/list/:id
[x] GET /api/v1/streaming/user
[x] GET /api/v1/streaming/public
[x] GET /api/v1/streaming/hashtag?tag=:hashtag
[x] GET /api/v1/streaming/hashtag/local?tag=:hashtag
[x] GET /api/v1/streaming/list?list=:list_id
[x] GET /api/v1/streaming/direct
[x] GET /api/v1/endorsements

Installation

go install github.com/mattn/go-mastodon@latest

License

MIT

Author

Yasuhiro Matsumoto (a.k.a. mattn)

mattn / go-mastodon

readme