friendica_2019-12_sharedHosting_hotFix/doc/API-Mastodon.md

Mastodon API

• Home
  • Using the APIs

Overview

Friendica provides the following endpoints defined in the official Mastodon API reference.

Authentication is the same as described in Using the APIs.

Clients

Supported mobile apps:

• Tusky
• Husky
• twitlatte
• AndStatus
• Twidere

Unsupported mobile apps:

• Subway Tooter Uses the wrong grant_type when requesting a token, possibly a problem in the server type detection of the app. See issue https://github.com/tateisu/SubwayTooter/issues/156
• Mammut States that the instance doesn't exist. Most likely an issue in the vitality check of the app, see issue https://github.com/jamiesanson/Mammut/issues/19
• Fedilab Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520

Entities

These endpoints use the Mastodon API entities.

Implemented endpoints

• GET /api/v1/accounts/:id

• GET /api/v1/accounts/:id/statuses

• GET /api/v1/accounts/:id/followers

• GET /api/v1/accounts/:id/following

• GET /api/v1/accounts/:id/lists

• GET /api/v1/accounts/search

• GET /api/v1/accounts/verify_credentials

• GET /api/v1/blocks

• GET /api/v1/bookmarks

• GET /api/v1/custom_emojis

  • Doesn't return unicode emojis since they aren't using an image URL

• GET /api/v1/directory

• GET /api/v1/favourites

• GET /api/v1/follow_requests

  • Returned IDs are specific to follow requests

• POST /api/v1/follow_requests/:id/authorize

  • :id is a follow request ID, not a regular account id

• POST /api/v1/follow_requests/:id/reject

  • :id is a follow request ID, not a regular account id

• POST /api/v1/follow_requests/:id/ignore

  • Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
  • :id is a follow request ID, not a regular account id
  • Returns a Relationship object.

• GET /api/v1/instance

• GET /api/v1/instance/peers

• GET /api/v1/lists

• GET /api/v1/lists/:id

• GET /api/v1/lists/:id/accounts

• GET /api/v1/media/:id

• GET /api/v1/mutes

• GET /api/v1/notifications

• GET /api/v1/notifications/:id

• GET /api/v1/preferences

• GET /api/v1/statuses/:id

• GET /api/v1/statuses/:id/context

• GET /api/v1/statuses/:id/reblogged_by

• GET /api/v1/statuses/:id/favourited_by

• GET /api/v1/suggestions

• GET /api/v1/timelines/home

• GET /api/v1/timelines/list/:id

• GET /api/v1/timelines/public

• GET /api/v1/timelines/tag/:hashtag

• GET /api/v1/trends

Non-implemented endpoints

• GET /api/v1/instance/activity