strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
friendica/doc/API-Mastodon.md

171 lines
12 KiB
Markdown
Raw Normal View History

Rework API documentation - Split API pages by target software - Added API entities list
2019-12-10 04:36:52 +01:00
# Mastodon API
* [Home](help)
* [Using the APIs](help/api)
## Overview
Friendica provides the following endpoints defined in [the official Mastodon API reference](https://docs.joinmastodon.org/api/).
Authentication is the same as described in [Using the APIs](help/api#Authentication).
Refine OAuth flow
2021-05-13 13:26:56 +02:00
## Clients
Supported mobile apps:
updated cAPI documentation
2021-05-14 08:30:02 +02:00
- [AndStatus](http://andstatus.org)
API: Account actions
2021-05-14 23:51:32 +02:00
- [Husky](https://husky.fwgs.ru)
updated cAPI documentation
2021-05-14 08:30:02 +02:00
- [Subway Tooter](https://github.com/tateisu/SubwayTooter)
API: Account actions
2021-05-14 23:51:32 +02:00
- [Tusky](https://tusky.app)
- [Twidere](https://github.com/TwidereProject/)
- [twitlatte](https://github.com/moko256/twitlatte)
- [Yuito](https://github.com/accelforce/Yuito)
Refine OAuth flow
2021-05-13 13:26:56 +02:00
Unsupported mobile apps:
- [Fedilab](https://framagit.org/tom79/fedilab) Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520
API: Account actions
2021-05-14 23:51:32 +02:00
- [Mammut](https://github.com/jamiesanson/Mammut) There are problems with the token request, see issue https://github.com/jamiesanson/Mammut/issues/19
Refine OAuth flow
2021-05-13 13:26:56 +02:00
Rework API documentation - Split API pages by target software - Added API entities list
2019-12-10 04:36:52 +01:00
## Entities
Update API-Mastodon.md
2019-12-21 14:24:24 +01:00
These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/).
Rework API documentation - Split API pages by target software - Added API entities list
2019-12-10 04:36:52 +01:00
## Implemented endpoints
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/accounts/:id`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
Improved documentation
2021-05-15 01:20:38 +02:00
- [`GET /api/v1/accounts/:id/statuses`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/followers`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/following`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/lists`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/follow`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/unfollow`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/block`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/unblock`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/mute`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/unmute`](https://docs.joinmastodon.org/methods/accounts/)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/accounts/:id/statuses`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
- [`GET /api/v1/accounts/:id/followers`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/following`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/lists`](https://docs.joinmastodon.org/methods/accounts/)
Fixed message, relationships endpoint added
2021-05-15 12:55:41 +02:00
- [`GET /api/v1/accounts/relationships`](https://docs.joinmastodon.org/methods/accounts/)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/accounts/search`](https://docs.joinmastodon.org/methods/accounts)
- [`GET /api/v1/accounts/verify_credentials`](https://docs.joinmastodon.org/methods/accounts)
Improved documentation
2021-05-15 01:20:38 +02:00
- [`POST /api/v1/apps`](https://docs.joinmastodon.org/methods/apps/)
API: Some more endpoints
2021-05-08 21:21:52 +02:00
- [`GET /api/v1/blocks`](https://docs.joinmastodon.org/methods/accounts/blocks/)
- [`GET /api/v1/bookmarks`](https://docs.joinmastodon.org/methods/accounts/bookmarks/)
Add custom emojis Mastodon API endpoint
2020-01-28 03:33:51 +01:00
- [`GET /api/v1/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/)
- Doesn't return unicode emojis since they aren't using an image URL
Added documentation
2020-11-01 00:42:42 +01:00
- [`GET /api/v1/directory`](https://docs.joinmastodon.org/methods/instance/directory/)
API: Some more endpoints
2021-05-08 21:21:52 +02:00
- [`GET /api/v1/favourites`](https://docs.joinmastodon.org/methods/accounts/favourites/)
Update Mastodon API documentation - Change endpoint label style to monospace - Explicit expected IDs for follow_requests endpoints - Add official documentation link for api/v1/instance/peers - Add unimplemented endpoint api/v1/instance/activity
2019-12-21 15:51:11 +01:00
- [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
- Returned IDs are specific to follow requests
- [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
- `:id` is a follow request ID, not a regular account id
- [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
- `:id` is a follow request ID, not a regular account id
- `POST /api/v1/follow_requests/:id/ignore`
Add POST follow request Mastodon API endpoint
2019-12-11 09:50:09 +01:00
- Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
Update Mastodon API documentation - Change endpoint label style to monospace - Explicit expected IDs for follow_requests endpoints - Add official documentation link for api/v1/instance/peers - Add unimplemented endpoint api/v1/instance/activity
2019-12-21 15:51:11 +01:00
- `:id` is a follow request ID, not a regular account id
Update API-Mastodon.md
2019-12-21 14:24:24 +01:00
- Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
Rework API documentation - Split API pages by target software - Added API entities list
2019-12-10 04:36:52 +01:00
Update Mastodon API documentation - Change endpoint label style to monospace - Explicit expected IDs for follow_requests endpoints - Add official documentation link for api/v1/instance/peers - Add unimplemented endpoint api/v1/instance/activity
2019-12-21 15:51:11 +01:00
- [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance#fetch-instance)
- [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
Improved documentation
2021-05-15 01:20:38 +02:00
- [`POST /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
Improved documentation
2021-05-15 01:20:38 +02:00
- [`PUT /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
- [`DELETE /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
Improved documentation
2021-05-15 01:20:38 +02:00
- [`POST /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
- [`DELETE /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
Media is now supported as well
2021-05-09 14:59:23 +02:00
- [`GET /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
API: Some more endpoints
2021-05-08 21:21:52 +02:00
- [`GET /api/v1/mutes`](https://docs.joinmastodon.org/methods/accounts/mutes/)
Notifications are now supported as well
2021-05-09 13:50:05 +02:00
- [`GET /api/v1/notifications`](https://docs.joinmastodon.org/methods/notifications/)
- [`GET /api/v1/notifications/:id`](https://docs.joinmastodon.org/methods/notifications/)
API: Many item related endpoints added
2021-05-15 12:08:47 +02:00
- [`POST /api/v1/notifications/clear`](https://docs.joinmastodon.org/methods/notifications/)
- [`POST /api/v1/notifications/:id/dismiss`](https://docs.joinmastodon.org/methods/notifications/)
API: added account related endpoints
2021-05-09 11:35:51 +02:00
- [`GET /api/v1/preferences`](https://docs.joinmastodon.org/methods/accounts/preferences/)
Changed documentation
2021-05-08 10:39:00 +02:00
- [`GET /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
API: Many item related endpoints added
2021-05-15 12:08:47 +02:00
- [`DELETE /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
API: Some more endpoints
2021-05-08 21:21:52 +02:00
- [`GET /api/v1/statuses/:id/context`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/statuses/:id/reblogged_by`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/statuses/:id/favourited_by`](https://docs.joinmastodon.org/methods/statuses/)
API: Many item related endpoints added
2021-05-15 12:08:47 +02:00
- [`POST /api/v1/statuses/:id/favourite`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/unfavourite`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/reblog`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/unreblog`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/bookmark`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/unbookmark`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/mute`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/unmute`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/pin`](https://docs.joinmastodon.org/methods/statuses/)
- [`POST /api/v1/statuses/:id/unpin`](https://docs.joinmastodon.org/methods/statuses/)
Suggestions are now supported as well
2021-05-08 13:03:50 +02:00
- [`GET /api/v1/suggestions`](https://docs.joinmastodon.org/methods/accounts/suggestions/)
Changed documentation
2021-05-08 10:39:00 +02:00
- [`GET /api/v1/timelines/home`](https://docs.joinmastodon.org/methods/timelines/)
- [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/)
Added documentation
2020-11-01 00:42:42 +01:00
- [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
Changed documentation
2021-05-08 10:39:00 +02:00
- [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/)
Added documentation
2020-11-01 00:42:42 +01:00
- [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/)
Rework API documentation - Split API pages by target software - Added API entities list
2019-12-10 04:36:52 +01:00
Improved documentation
2021-05-15 01:20:38 +02:00
## Currently unimplemented endpoints
These emdpoints are planned to be implemented
- [`POST /api/v1/accounts/:id/note`](https://docs.joinmastodon.org/methods/accounts/)
- [`PATCH /api/v1/accounts/update_credentials`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/apps/verify_credentials`](https://docs.joinmastodon.org/methods/apps/)
- [`GET /api/v1/conversations`](https://docs.joinmastodon.org/methods/timelines/conversations/)
- [`DELETE /api/v1/conversations/:id`](https://docs.joinmastodon.org/methods/timelines/conversations/)
- [`POST /api/v1/conversations/:id/read`](https://docs.joinmastodon.org/methods/timelines/conversations/)
- [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)
- [`POST /api/v1/media`](https://docs.joinmastodon.org/methods/statuses/media/)
- [`PUT /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
- [`POST /api/v1/statuses`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/)
## Non supportable endpoints
These endpoints won't be implemented, since they refer to functionality that doesn't exist in Friendica
Update Mastodon API documentation - Change endpoint label style to monospace - Explicit expected IDs for follow_requests endpoints - Add official documentation link for api/v1/instance/peers - Add unimplemented endpoint api/v1/instance/activity
2019-12-21 15:51:11 +01:00
Improved documentation
2021-05-15 01:20:38 +02:00
- [`POST /api/v1/accounts`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/accounts/:id/identity_proofs`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/pin`](https://docs.joinmastodon.org/methods/accounts/)
- [`POST /api/v1/accounts/:id/unpin`](https://docs.joinmastodon.org/methods/accounts/)
- [`GET /api/v1/admin/accounts`](https://docs.joinmastodon.org/methods/admin/)
- [`GET /api/v1/admin/accounts/:id`](https://docs.joinmastodon.org/methods/admin/)
- [`POST /api/v1/admin/accounts/:id/{action}`](https://docs.joinmastodon.org/methods/admin/)
- [`GET /api/v1/admin/reports`](https://docs.joinmastodon.org/methods/admin/)
- [`GET /api/v1/admin/reports/:id`](https://docs.joinmastodon.org/methods/admin/)
- [`POST /api/v1/admin/reports/:id/{action}`](https://docs.joinmastodon.org/methods/admin/)
- [`GET /api/v1/announcements`](https://docs.joinmastodon.org/methods/announcements/)
- [`POST /api/v1/announcements/:id/dismiss`](https://docs.joinmastodon.org/methods/announcements/)
- [`PUT /api/v1/announcements/:id/reactions/{name}`](https://docs.joinmastodon.org/methods/announcements/)
- [`DELETE /api/v1/announcements/:id/reactions/{name}`](https://docs.joinmastodon.org/methods/announcements/)
- [`GET /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
- [`POST /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
- [`DELETE /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
- [`GET /api/v1/endorsements`](https://docs.joinmastodon.org/methods/accounts/endorsements/)
- [`GET /api/v1/featured_tags`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
- [`POST /api/v1/featured_tags`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
- [`DELETE /api/v1/featured_tags/:id`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
- [`GET /api/v1/featured_tags/suggestions`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
- [`GET /api/v1/filters`](https://docs.joinmastodon.org/methods/accounts/filters/)
- [`GET /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
- [`POST /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
- [`PUT /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
- [`DELETE /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
- [`GET /api/v1/markers`](https://docs.joinmastodon.org/methods/timelines/markers/)
- [`POST /api/v1/markers`](https://docs.joinmastodon.org/methods/timelines/markers/)
- [`GET /api/v1/polls/:id`](https://docs.joinmastodon.org/methods/statuses/polls/)
- [`POST /api/v1/polls/:id/votes`](https://docs.joinmastodon.org/methods/statuses/polls/)
- [`POST /api/v1/reports`](https://docs.joinmastodon.org/methods/accounts/reports/)
- [`GET /api/v1/scheduled_statuses`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
- [`GET /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
- [`PUT /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
- [`DELETE /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
- [`DELETE /api/v1/suggestions/:id`](https://docs.joinmastodon.org/methods/accounts/suggestions/)
Reference in a new issue Copy permalink