Merge pull request #10165 from nupplaphil/bug/strip_pageinfo
[friendica.git/.git] / 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/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/)
21     - Doesn't return unicode emojis since they aren't using an image URL
22
23
24 - [`GET /api/v1/directory`](https://docs.joinmastodon.org/methods/instance/directory/)
25 - [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
26     - Returned IDs are specific to follow requests
27 - [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
28     - `:id` is a follow request ID, not a regular account id
29 - [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
30     - `:id` is a follow request ID, not a regular account id
31 - `POST /api/v1/follow_requests/:id/ignore`
32     - Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
33     - `:id` is a follow request ID, not a regular account id
34     - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
35
36
37 - [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance#fetch-instance)
38 - [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
39 - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
40 - [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/)
41
42 ## Non-implemented endpoints
43
44 - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)