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 ## Entities
  13
  14 These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/).
  15
  16 ## Implemented endpoints
  17
  18 - [`GET /api/v1/accounts/:id`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
  19 - [`GET /api/v1/accounts/:id/statuses`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
  20 - [`GET /api/v1/accounts/:id/followers`](https://docs.joinmastodon.org/methods/accounts/)
  21 - [`GET /api/v1/accounts/:id/following`](https://docs.joinmastodon.org/methods/accounts/)
  22 - [`GET /api/v1/accounts/:id/lists`](https://docs.joinmastodon.org/methods/accounts/)
  23 - [`GET /api/v1/accounts/search`](https://docs.joinmastodon.org/methods/accounts)
  24 - [`GET /api/v1/accounts/verify_credentials`](https://docs.joinmastodon.org/methods/accounts)
  25 - [`GET /api/v1/blocks`](https://docs.joinmastodon.org/methods/accounts/blocks/)
  26 - [`GET /api/v1/bookmarks`](https://docs.joinmastodon.org/methods/accounts/bookmarks/)
  27 - [`GET /api/v1/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/)
  28     - Doesn't return unicode emojis since they aren't using an image URL
  29
  30
  31 - [`GET /api/v1/directory`](https://docs.joinmastodon.org/methods/instance/directory/)
  32 - [`GET /api/v1/favourites`](https://docs.joinmastodon.org/methods/accounts/favourites/)
  33 - [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
  34     - Returned IDs are specific to follow requests
  35 - [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
  36     - `:id` is a follow request ID, not a regular account id
  37 - [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
  38     - `:id` is a follow request ID, not a regular account id
  39 - `POST /api/v1/follow_requests/:id/ignore`
  40     - Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
  41     - `:id` is a follow request ID, not a regular account id
  42     - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
  43
  44
  45 - [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance#fetch-instance)
  46 - [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
  47 - [`GET /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
  48 - [`GET /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
  49 - [`GET /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
  50 - [`GET /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
  51 - [`GET /api/v1/mutes`](https://docs.joinmastodon.org/methods/accounts/mutes/)
  52 - [`GET /api/v1/notifications`](https://docs.joinmastodon.org/methods/notifications/)
  53 - [`GET /api/v1/notifications/:id`](https://docs.joinmastodon.org/methods/notifications/)
  54 - [`GET /api/v1/preferences`](https://docs.joinmastodon.org/methods/accounts/preferences/)
  55 - [`GET /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
  56 - [`GET /api/v1/statuses/:id/context`](https://docs.joinmastodon.org/methods/statuses/)
  57 - [`GET /api/v1/statuses/:id/reblogged_by`](https://docs.joinmastodon.org/methods/statuses/)
  58 - [`GET /api/v1/statuses/:id/favourited_by`](https://docs.joinmastodon.org/methods/statuses/)
  59 - [`GET /api/v1/suggestions`](https://docs.joinmastodon.org/methods/accounts/suggestions/)
  60 - [`GET /api/v1/timelines/home`](https://docs.joinmastodon.org/methods/timelines/)
  61 - [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/)
  62 - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
  63 - [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/)
  64 - [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/)
  65
  66 ## Non-implemented endpoints
  67
  68 - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)