3 <!-- markdownlint-disable MD010 MD013 MD024 -->
7 The Friendica API aims to be compatible with the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).
9 Please refer to the linked documentation for further information.
11 ## Implemented API calls
17 API endpoints can restrict the method used to request them.
18 Using an invalid method results in HTTP error 405 "Method Not Allowed".
20 In this document, the required method is listed after the endpoint name. "*" means every method can be used.
24 Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.
26 OAuth settings can be added by the user in web UI under /settings/oauth/
28 In this document, endpoints which requires auth are marked with "AUTH" after endpoint name
30 #### Unsupported parameters
32 * cursor: Not implemented in GNU Social
33 * trim_user: Not implemented in GNU Social
34 * contributor_details: Not implemented in GNU Social
35 * place_id: Not implemented in GNU Social
36 * display_coordinates: Not implemented in GNU Social
38 * include_my_retweet: Retweets in Friendica are implemented in a different way
40 #### Different behaviour
42 * screen_name: The nick name in friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
43 * include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
47 * cid: Contact id of the user (important for "contact_allow" and "contact_deny")
48 * network: network of the user
52 When an error occurs in API call, an HTTP error code is returned, with an error message
55 * 400 Bad Request: if parameters are missing or items can't be found
56 * 403 Forbidden: if the authenticated user is missing
57 * 405 Method Not Allowed: if API was called with an invalid method, eg. GET when API require POST
58 * 501 Not Implemented: if the requested API doesn't exist
59 * 500 Internal Server Error: on other error conditions
67 "error": "Specific error message",
68 "request": "API path requested",
69 "code": "HTTP error code"
77 <error>Specific error message</error>
78 <request>API path requested</request>
79 <code>HTTP error code</code>
85 ### account/rate_limit_status (*; AUTH)
89 ### account/verify_credentials (*; AUTH)
93 * skip_status: Don't show the "status" field. (Default: false)
94 * include_entities: "true" shows entities for pictures and links (Default: false)
98 ### conversation/show (*; AUTH)
100 Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
105 * count: Items per page (default: 20)
107 * since_id: minimum id
109 * include_entities: "true" shows entities for pictures and links (Default: false)
111 #### Unsupported parameters
115 * contributor_details
119 ### direct_messages (*; AUTH)
123 * count: Items per page (default: 20)
125 * since_id: minimum id
127 * getText: Defines the format of the status field. Can be "html" or "plain"
128 * include_entities: "true" shows entities for pictures and links (Default: false)
129 * friendica_verbose: "true" enables different error returns (default: "false")
131 #### Unsupported parameters
137 ### direct_messages/all (*; AUTH)
141 * count: Items per page (default: 20)
143 * since_id: minimum id
145 * getText: Defines the format of the status field. Can be "html" or "plain"
146 * friendica_verbose: "true" enables different error returns (default: "false")
150 ### direct_messages/conversation (*; AUTH)
152 Shows all direct messages of a conversation
156 * count: Items per page (default: 20)
158 * since_id: minimum id
160 * getText: Defines the format of the status field. Can be "html" or "plain"
161 * uri: URI of the conversation
162 * friendica_verbose: "true" enables different error returns (default: "false")
166 ### direct_messages/sent (*; AUTH)
170 * count: Items per page (default: 20)
172 * since_id: minimum id
174 * getText: Defines the format of the status field. Can be "html" or "plain"
175 * include_entities: "true" shows entities for pictures and links (Default: false)
176 * friendica_verbose: "true" enables different error returns (default: "false")
180 ### direct_messages/new (POST,PUT; AUTH)
184 * user_id: id of the user
185 * screen_name: screen name (for technical reasons, this value is not unique!)
187 * replyto: ID of the replied direct message
188 * title: Title of the direct message
192 ### direct_messages/destroy (POST,DELETE; AUTH)
196 * id: id of the message to be deleted
197 * include_entities: optional, currently not yet implemented
198 * friendica_parenturi: optional, can be used for increased safety to delete only intended messages
199 * friendica_verbose: "true" enables different error returns (default: "false")
205 * JSON return as defined for Twitter API not yet implemented
206 * on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
211 * on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
215 ### externalprofile/show (*)
219 * profileurl: profile url
223 ### favorites (*; AUTH)
227 * count: Items per page (default: 20)
229 * since_id: minimum id
231 * include_entities: "true" shows entities for pictures and links (Default: false)
233 #### Unsupported parameters
238 Favorites aren't displayed to other users, so "user_id" and "screen_name" are unsupported.
239 Set this values will result in an empty array.
243 ### favorites/create (POST,PUT; AUTH)
248 * include_entities: "true" shows entities for pictures and links (Default: false)
252 ### favorites/destroy (POST,DELETE; AUTH)
257 * include_entities: "true" shows entities for pictures and links (Default: false)
261 ### followers/ids (*; AUTH)
265 * stringify_ids: Send id numbers as text (true) or integers (false)? (default: false)
267 #### Unsupported parameters
273 Friendica doesn't allow showing the followers of other users.
277 ### friends/ids (*; AUTH)
281 * stringify_ids: Send the id numbers as text (true) or integers (false)? (default: false)
283 #### Unsupported parameters
289 Friendica doesn't allow showing the friends of other users.
297 ### lists/ownerships (*; AUTH)
301 * list_id: ID of the list
302 * count: Items per page
304 * since_id: Minimum ID
307 #### Unsupported parameters
317 ### lists/destroy (POST; AUTH)
321 * list_id: ID of the list
323 #### Unsupported parameters
331 ### lists/create (POST; AUTH)
335 * name: name of the list
337 #### Unsupported parameters
344 ### lists/update (POST; AUTH)
348 * list_id: ID of the list
349 * name: name of the list
351 #### Unsupported parameters
362 ### lists/statuses (*; AUTH)
366 * user_id: ID of the user for whom to return results.
368 #### Unsupported parameters
376 ### media/upload (POST,PUT; AUTH)
384 ### oauth/request_token (*)
390 #### Unsupported parameters
396 ### oauth/access_token (*)
402 #### Unsupported parameters
410 ### statuses/destroy (POST,DELETE; AUTH)
415 * include_entities: "true" shows entities for pictures and links (Default: false)
417 #### Unsupported parameters
423 ### statuses/followers (*; AUTH)
427 * include_entities: "true" shows entities for pictures and links (Default: false)
431 ### statuses/friends (*; AUTH)
435 * include_entities: "true" shows entities for pictures and links (Default: false)
436 * count: how many items should be shown (Default: 20)
440 ### blocks/list (*; AUTH)
444 * include_entities: "true" shows entities for pictures and links (Default: false)
445 * count: Items per page (default: 20).
448 #### Unsupported parameters
455 ### statuses/friends_timeline (*; AUTH)
459 * count: Items per page (default: 20)
461 * since_id: minimum id
463 * exclude_replies: don't show replies (default: false)
464 * conversation_id: Shows all statuses of a given conversation.
465 * include_entities: "true" shows entities for pictures and links (Default: false)
467 #### Unsupported parameters
471 * contributor_details
475 ### statuses/home_timeline (*; AUTH)
479 * count: Items per page (default: 20)
481 * since_id: minimum id
483 * exclude_replies: don't show replies (default: false)
484 * conversation_id: Shows all statuses of a given conversation.
485 * include_entities: "true" shows entities for pictures and links (Default: false)
487 #### Unsupported parameters
491 * contributor_details
495 ### statuses/mentions (*; AUTH)
499 * count: Items per page (default: 20)
501 * since_id: minimum id
503 * include_entities: "true" shows entities for pictures and links (Default: false)
505 #### Unsupported parameters
509 * contributor_details
513 ### statuses/public_timeline (*; AUTH)
517 * count: Items per page (default: 20)
519 * since_id: minimum id
521 * exclude_replies: don't show replies (default: false)
522 * conversation_id: Shows all statuses of a given conversation.
523 * include_entities: "true" shows entities for pictures and links (Default: false)
525 #### Unsupported parameters
531 ### statuses/networkpublic_timeline (*; AUTH)
535 * count: Items per page (default: 20)
537 * since_id: minimum id
539 * include_entities: "true" shows entities for pictures and links (Default: false)
543 ### statuses/replies (*; AUTH)
547 * count: Items per page (default: 20)
549 * since_id: minimum id
551 * include_entities: "true" shows entities for pictures and links (Default: false)
553 #### Unsupported parameters
557 * contributor_details
561 ### statuses/retweet (POST,PUT; AUTH)
566 * include_entities: "true" shows entities for pictures and links (Default: false)
568 #### Unsupported parameters
574 ### statuses/show (*; AUTH)
579 * conversation: if set to "1" show all messages of the conversation with the given id
580 * include_entities: "true" shows entities for pictures and links (Default: false)
582 #### Unsupported parameters
589 ### statuses/update, statuses/update_with_media
593 * title: Title of the status
594 * status: Status in text format
595 * htmlstatus: Status in HTML format
596 * in_reply_to_status_id
600 * source: Application name
606 * include_entities: "true" shows entities for pictures and links (Default: false)
607 * media_ids: (By now only a single value, no array)
609 #### Unsupported parameters
613 * display_coordinates
617 ### statuses/user_timeline (*; AUTH)
621 * user_id: id of the user
622 * screen_name: screen name (for technical reasons, this value is not unique!)
623 * count: Items per page (default: 20)
625 * since_id: minimum id
627 * exclude_replies: don't show replies (default: false)
628 * conversation_id: Shows all statuses of a given conversation.
629 * include_entities: "true" shows entities for pictures and links (Default: false)
631 #### Unsupported parameters
635 * contributor_details
639 ### statusnet/config (*)
643 ### statusnet/conversation (*; AUTH)
645 It shows all direct answers (excluding the original post) to a given id.
650 * count: Items per page (default: 20)
652 * since_id: minimum id
654 * include_entities: "true" shows entities for pictures and links (Default: false)
658 ### statusnet/version (*)
660 #### Unsupported parameters
666 Friendica doesn't allow showing followers of other users.
675 * page: the page number (starting at 1) to return
676 * rpp: the number of statuses to return per page
677 * count: alias for the rpp parameter
678 * since_id: returns statuses with ids greater than the given id
679 * max_id: returns statuses with ids lower or equal to the given id
681 #### Unsupported parameters
692 ### search/tweets (*; AUTH)
694 This is an alias for `search`.
698 ### saved_searches/list (*; AUTH)
700 This call does not have any parameter.
708 * q: name of the user
710 #### Unsupported parameters
722 * user_id: id of the user
723 * screen_name: screen name (for technical reasons, this value is not unique!)
724 * include_entities: "true" shows entities for pictures and links (Default: false)
726 #### Unsupported parameters
732 Friendica doesn't allow showing friends of other users.
736 ### users/lookup (*; AUTH)
740 * user_id: list of ids to lookup
742 #### Unsupported parameters
749 ### account/update_profile_image (POST; AUTH)
753 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
754 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
756 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
762 * JSON return: returns the updated user details (see account/verify_credentials)
766 * 403 FORBIDDEN: if not authenticated
767 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
768 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
769 "image size exceeds Friendica Config setting (uploaded size: x)",
770 "unable to process image data",
771 "image upload failed"
775 ### account/update_profile (POST; AUTH)
779 * name (optional): full name of the user
780 * description (optional): a description of the user
782 #### Unsupported parameters
792 ### friendships/incoming (*; AUTH)
794 #### Unsupported parameters
799 ## Implemented API calls (not compatible with other APIs)
803 ### friendica/activity/[verb]
809 Add or remove an activity from an item.
810 'verb' can be one of:
818 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
819 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
820 Attend verbs should be used only with event-related items (there is no check at the moment)
838 ### friendica/group_show (*; AUTH)
840 Return all or a specified group of the user with the containing contacts as array.
844 * gid: optional, if not given, API returns all groups of the user
850 * name: name of the group
851 * gid: id of the group
852 * user: array of group members (return from api_get_user() function for each member)
856 ### friendica/group_delete (POST,DELETE; AUTH)
858 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
862 * gid: id of the group to be deleted
863 * name: name of the group to be deleted
869 * success: true if successfully deleted
870 * gid: gid of the deleted group
871 * name: name of the deleted group
872 * status: „deleted“ if successfully deleted
873 * wrong users: empty array
877 ### friendica/group_create (POST,PUT; AUTH)
879 Create the group with the posted array of contacts as members.
883 * name: name of the group to be created
887 JSON data as Array like the result of "users/group_show":
897 * success: true if successfully created or reactivated
898 * gid: gid of the created group
899 * name: name of the created group
900 * status: „missing user“ | „reactivated“ | „ok“
901 * wrong users: array of users, which were not available in the contact table
905 ### friendica/group_update (POST)
907 Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
911 * gid: id of the group to be changed
912 * name: name of the group to be changed
916 JSON data as array like the result of „users/group_show“:
926 * success: true if successfully updated
927 * gid: gid of the changed group
928 * name: name of the changed group
929 * status: „missing user“ | „ok“
930 * wrong users: array of users, which were not available in the contact table
934 ### friendica/notifications (GET)
936 Return last 50 notification for current user, ordered by date with unseen item on top
947 * type: type of notification as int (see NOTIFY_* constants in boot.php)
948 * name: full name of the contact subject of the note
949 * url: contact's profile url
950 * photo: contact's profile photo
951 * date: datetime string of the note
952 * timestamp: timestamp of the node
953 * date_rel: relative date of the note (eg. "1 hour ago")
954 * msg: note message in bbcode
955 * msg_html: note message in html
956 * msg_plain: note message in plain text
958 * seen: seen state: 0 or 1
962 ### friendica/notifications/seen (POST)
964 Set note as seen, returns item object if possible
968 id: id of the note to set seen
972 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
974 If the note is not linked to an item, a success status is returned:
976 * `success` (json) | `<status>success</status>` (xml)
980 ### friendica/photo (*; AUTH)
984 * photo_id: Resource id of a photo.
985 * scale: (optional) scale value of the photo
987 Returns data of a picture with the given resource.
988 If 'scale' isn't provided, returned data include full url to each scale of the photo.
989 If 'scale' is set, returned data include image data base64 encoded.
991 possibile scale value are:
993 * 0: original or max size by server settings
994 * 1: image with or height at <= 640
995 * 2: image with or height at <= 320
996 * 3: thumbnail 160x160
997 * 4: Profile image at 175x175
998 * 5: Profile image at 80x80
999 * 6: Profile image at 48x48
1001 An image used as profile image has only scale 4-6, other images only 0-3
1010 "created": "date(YYYY-MM-DD HH:MM:SS)",
1011 "edited": "date(YYYY-MM-DD HH:MM:SS)",
1012 "title": "photo title",
1013 "desc": "photo description",
1014 "album": "album name",
1015 "filename": "original file name",
1016 "type": "mime type",
1019 "profile": "1 if is profile photo",
1021 "<scale>": "url to image"
1024 // if 'scale' is set
1025 "datasize": "size in byte",
1026 "data": "base64 encoded image data"
1035 <created>date(YYYY-MM-DD HH:MM:SS)</created>
1036 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
1037 <title>photo title</title>
1038 <desc>photo description</desc>
1039 <album>album name</album>
1040 <filename>original file name</filename>
1041 <type>mime type</type>
1042 <height>number</height>
1043 <width>number</width>
1044 <profile>1 if is profile photo</profile>
1045 <links type="array">
1046 <link type="mime type" scale="scale number" href="image url"/>
1054 ### friendica/photos/list (*; AUTH)
1056 Returns a list of all photo resources of the logged in user.
1066 album: "album name",
1067 filename: "original file name",
1068 type: "image mime type",
1069 thumb: "url to thumb sized image"
1078 <photos type="array">
1079 <photo id="resource_id"
1081 filename="original file name"
1082 type="image mime type">
1083 "url to thumb sized image"
1091 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
1095 * album: name of the album to be deleted
1097 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
1103 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
1107 * 403 FORBIDDEN: if not authenticated
1108 * 400 BADREQUEST: "no albumname specified", "album not available"
1109 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1113 ### friendica/photoalbum/update (POST,PUT; AUTH)
1117 * album: name of the album to be updated
1118 * album_new: new name of the album
1120 changes the album name to album_new for all photos in album
1126 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1130 * 403 FORBIDDEN: if not authenticated
1131 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1132 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1136 ### friendica/photo/create (POST; AUTH)
1138 ### friendica/photo/update (POST; AUTH)
1142 * photo_id (optional): if specified the photo with this id will be updated
1143 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1144 * desc (optional): description for the photo, updated when photo_id is specified
1145 * album: name of the album to be deleted (always necessary)
1146 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1147 * allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '```<x><y><z>```' for private photo;
1148 on update: keys need to be present with empty values for changing a private photo to public
1150 both calls point to one function for creating AND updating photos.
1151 Saves data for the scales 0-2 to database (see above for scale description).
1152 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1153 Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
1154 Currently it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead.
1160 * new photo uploaded: JSON return with photo data (see friendica/photo)
1161 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1162 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1163 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1167 * 403 FORBIDDEN: if not authenticated
1168 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1169 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1170 "image size exceeds Friendica Config setting (uploaded size: x)",
1171 "unable to process image data",
1172 "image upload failed",
1173 "unknown error - uploading photo failed, see Friendica log for more information",
1174 "unknown error - update photo entry in database failed",
1175 "unknown error - this error on uploading or updating a photo should never happen"
1179 ### friendica/photo/delete (DELETE; AUTH)
1183 * photo_id: id of the photo to be deleted
1185 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1186 Sets item table entries for this photo to deleted = 1
1192 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1196 * 403 FORBIDDEN: if not authenticated
1197 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1198 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1202 ### friendica/direct_messages_setseen (GET; AUTH)
1206 * id: id of the message to be updated as seen
1212 * JSON return {"result":"ok","message":"message set to seen"}
1216 * different JSON returns {"result":"error","message":"xyz"}
1220 ### friendica/direct_messages_search (GET; AUTH)
1224 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1228 Returns only tested with JSON, XML might work as well.
1232 * JSON return {"success":"true","search_results": array of found messages}
1233 * JSOn return {"success":"false","search_results":"nothing found"}
1237 * different JSON returns {"result":"error","message":"searchstring not specified"}
1241 ### friendica/profile/show (GET; AUTH)
1243 show data of all profiles or a single profile of the authenticated user
1247 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1251 On success: Array of:
1253 * multi_profiles: true if user has activated multi_profiles
1254 * global_dir: URL of the global directory set in server settings
1255 * friendica_owner: user data of the authenticated user
1256 * profiles: array of the profile data
1259 HTTP 403 Forbidden: when no authentication was provided
1260 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1262 General description of profile data in API returns:
1266 * is_default: true if this is the public profile
1267 * hide_friends: true if friends are hidden
1270 * publish: true if published on the server's local directory
1271 * net_publish: true if published to global_dir
1272 * description ... homepage: different data fields from 'profile' table in database
1273 * users: array with the users allowed to view this profile (empty if is_default=true)
1277 ## Not Implemented API calls
1279 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1281 * statuses/retweets_of_me
1282 * friendships/create
1283 * friendships/destroy
1284 * friendships/exists
1286 * account/update_profile_background_image
1290 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1292 * statuses/mentions_timeline
1293 * statuses/retweets/:id
1295 * statuses/retweeters/ids
1297 * direct_messages/show
1298 * friendships/no_retweets/ids
1299 * friendships/outgoing
1300 * friendships/update
1302 * friendships/lookup
1304 * account/update_delivery_device
1308 * account/remove_profile_banner
1309 * account/update_profile_banner
1310 * users/profile_banner
1311 * mutes/users/create
1312 * mutes/users/destroy
1315 * users/suggestions/:slug
1317 * users/suggestions/:slug/members
1320 * lists/members/destroy
1323 * lists/subscribers/create
1324 * lists/subscribers/show
1325 * lists/subscribers/destroy
1326 * lists/members/create_all
1327 * lists/members/show
1329 * lists/members/create
1331 * lists/subscriptions
1332 * lists/members/destroy_all
1333 * saved_searches/show/:id
1334 * saved_searches/create
1335 * saved_searches/destroy/:id
1337 * geo/reverse_geocode
1342 * help/configuration
1358 /usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"
1363 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1364 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1366 def tweet(server, message, group_allow=None):
1367 url = server + '/api/statuses/update'
1368 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1370 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.