doc/API-Mastodon.md

   1 # Mastodon API
   2
   3 * [Home](help)
   4   * [Using the APIs](help/api)
   5
   6 ## Overview
   7
   8 Friendica provides the following endpoints defined in [the official Mastodon API reference](https://docs.joinmastodon.org/api/).
   9
  10 Authentication is the same as described in [Using the APIs](help/api#Authentication).
  11
  12 ## Clients
  13
  14 Supported mobile apps:
  15
  16 - [Tusky](https://tusky.app)
  17 - [Husky](https://husky.fwgs.ru)
  18 - [twitlatte](https://github.com/moko256/twitlatte)
  19 - [AndStatus](http://andstatus.org)
  20 - [Twidere](https://github.com/TwidereProject/)
  21 - [Subway Tooter](https://github.com/tateisu/SubwayTooter)
  22
  23 Unsupported mobile apps:
  24
  25 - [Mammut](https://github.com/jamiesanson/Mammut) There are problems with the token request, see issue https://github.com/jamiesanson/Mammut/issues/19
  26 - [Fedilab](https://framagit.org/tom79/fedilab) Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520
  27
  28 ## Entities
  29
  30 These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/).
  31
  32 ## Implemented endpoints
  33
  34 - [`GET /api/v1/accounts/:id`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
  35 - [`GET /api/v1/accounts/:id/statuses`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
  36 - [`GET /api/v1/accounts/:id/followers`](https://docs.joinmastodon.org/methods/accounts/)
  37 - [`GET /api/v1/accounts/:id/following`](https://docs.joinmastodon.org/methods/accounts/)
  38 - [`GET /api/v1/accounts/:id/lists`](https://docs.joinmastodon.org/methods/accounts/)
  39 - [`GET /api/v1/accounts/search`](https://docs.joinmastodon.org/methods/accounts)
  40 - [`GET /api/v1/accounts/verify_credentials`](https://docs.joinmastodon.org/methods/accounts)
  41 - [`GET /api/v1/blocks`](https://docs.joinmastodon.org/methods/accounts/blocks/)
  42 - [`GET /api/v1/bookmarks`](https://docs.joinmastodon.org/methods/accounts/bookmarks/)
  43 - [`GET /api/v1/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/)
  44     - Doesn't return unicode emojis since they aren't using an image URL
  45
  46
  47 - [`GET /api/v1/directory`](https://docs.joinmastodon.org/methods/instance/directory/)
  48 - [`GET /api/v1/favourites`](https://docs.joinmastodon.org/methods/accounts/favourites/)
  49 - [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
  50     - Returned IDs are specific to follow requests
  51 - [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
  52     - `:id` is a follow request ID, not a regular account id
  53 - [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
  54     - `:id` is a follow request ID, not a regular account id
  55 - `POST /api/v1/follow_requests/:id/ignore`
  56     - Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
  57     - `:id` is a follow request ID, not a regular account id
  58     - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
  59
  60
  61 - [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance#fetch-instance)
  62 - [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
  63 - [`GET /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
  64 - [`GET /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
  65 - [`GET /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
  66 - [`GET /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
  67 - [`GET /api/v1/mutes`](https://docs.joinmastodon.org/methods/accounts/mutes/)
  68 - [`GET /api/v1/notifications`](https://docs.joinmastodon.org/methods/notifications/)
  69 - [`GET /api/v1/notifications/:id`](https://docs.joinmastodon.org/methods/notifications/)
  70 - [`GET /api/v1/preferences`](https://docs.joinmastodon.org/methods/accounts/preferences/)
  71 - [`GET /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
  72 - [`GET /api/v1/statuses/:id/context`](https://docs.joinmastodon.org/methods/statuses/)
  73 - [`GET /api/v1/statuses/:id/reblogged_by`](https://docs.joinmastodon.org/methods/statuses/)
  74 - [`GET /api/v1/statuses/:id/favourited_by`](https://docs.joinmastodon.org/methods/statuses/)
  75 - [`GET /api/v1/suggestions`](https://docs.joinmastodon.org/methods/accounts/suggestions/)
  76 - [`GET /api/v1/timelines/home`](https://docs.joinmastodon.org/methods/timelines/)
  77 - [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/)
  78 - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
  79 - [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/)
  80 - [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/)
  81
  82 ## Non-implemented endpoints
  83
  84 - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)