friendica/doc/API-Mastodon.md
Hank Grabowski 467193c661 Add Mastodon Status Entity Friendica extensions (minus quote)
- I can't figure out how to get the quote one to populate, check if still relevant
2023-02-22 21:49:56 -05:00

16 KiB

Mastodon API

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 apps

For supported apps please have a look at the FAQ

Unsupported apps

Android

iOS

  • Mast Doesn't accept the entered instance name. Claims that it is invalid (Message is: "Not a valid instance (may be closed or dead)")
  • Toot!

Entities

These endpoints use the Mastodon API entities. With some additional extensions listed below.

Status Entities

Extensions to the Mastodon Status Entities

  • in_reply_to_status: A fully populated Mastodon Status entity for the replied to status or null it is a post rather than a response
  • friendica: Friendica specific properties of a status including:
    • title: The Friendica title for a post, or empty if the status is a comment
    • dislikes_count: The number of dislikes that a status has accumulated according to the server.

Example:

{
  "id": "358",
  "created_at": "2023-02-23T02:45:46.000Z",
  "in_reply_to_id": "356",
  "in_reply_to_status": {
	"id": "356",
	"created_at": "2023-02-23T02:45:35.000Z",
	"in_reply_to_id": null,
	"in_reply_to_status": null,
	"in_reply_to_account_id": null,
	...
	"content": "A post from testuser1",
	...
	"account": {
	  "id": "6",
	  "username": "testuser1",
	  "acct": "testuser1",
	  "display_name": "testuser1",
	  ...
	},
	...
	"friendica": {
	  "title": "",
	  "dislikes_count": 0
	}
  },
  "in_reply_to_account_id": "6",
  ...
  "replies_count": 0,
  "reblogs_count": 0,
  "favourites_count": 0,
  ...
  "content": "A reply from testuser2",
  ...
  "account": {
	"id": "8",
	"username": "testuser2",
	"acct": "testuser2",
	"display_name": "testuser2",
	...
  },
  ...
  "friendica": {
	"title": "",
	"dislikes_count": 0
  }
}

Implemented endpoints

Currently unimplemented endpoints

These emdpoints are planned to be implemented somewhere in the future.

Dummy endpoints

These endpoints are returning empty data to avoid error messages when using third party clients. They refer to features that don't exist in Friendica yet.

Non supportable endpoints

These endpoints won't be implemented at the moment. They refer to features or data that don't exist in Friendica yet.