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 ### media/upload (POST,PUT; AUTH)
305 ### oauth/request_token (*)
311 #### Unsupported parameters
317 ### oauth/access_token (*)
323 #### Unsupported parameters
331 ### statuses/destroy (POST,DELETE; AUTH)
336 * include_entities: "true" shows entities for pictures and links (Default: false)
338 #### Unsupported parameters
344 ### statuses/followers (*; AUTH)
348 * include_entities: "true" shows entities for pictures and links (Default: false)
352 ### statuses/friends (*; AUTH)
356 * include_entities: "true" shows entities for pictures and links (Default: false)
360 ### blocks/list (*; AUTH)
364 * include_entities: "true" shows entities for pictures and links (Default: false)
365 * count: Items per page (default: 20).
368 #### Unsupported parameters
375 ### statuses/friends_timeline (*; AUTH)
379 * count: Items per page (default: 20)
381 * since_id: minimum id
383 * exclude_replies: don't show replies (default: false)
384 * conversation_id: Shows all statuses of a given conversation.
385 * include_entities: "true" shows entities for pictures and links (Default: false)
387 #### Unsupported parameters
391 * contributor_details
395 ### statuses/home_timeline (*; AUTH)
399 * count: Items per page (default: 20)
401 * since_id: minimum id
403 * exclude_replies: don't show replies (default: false)
404 * conversation_id: Shows all statuses of a given conversation.
405 * include_entities: "true" shows entities for pictures and links (Default: false)
407 #### Unsupported parameters
411 * contributor_details
415 ### statuses/mentions (*; AUTH)
419 * count: Items per page (default: 20)
421 * since_id: minimum id
423 * include_entities: "true" shows entities for pictures and links (Default: false)
425 #### Unsupported parameters
429 * contributor_details
433 ### statuses/public_timeline (*; AUTH)
437 * count: Items per page (default: 20)
439 * since_id: minimum id
441 * exclude_replies: don't show replies (default: false)
442 * conversation_id: Shows all statuses of a given conversation.
443 * include_entities: "true" shows entities for pictures and links (Default: false)
445 #### Unsupported parameters
451 ### statuses/networkpublic_timeline (*; AUTH)
455 * count: Items per page (default: 20)
457 * since_id: minimum id
459 * include_entities: "true" shows entities for pictures and links (Default: false)
463 ### statuses/replies (*; AUTH)
467 * count: Items per page (default: 20)
469 * since_id: minimum id
471 * include_entities: "true" shows entities for pictures and links (Default: false)
473 #### Unsupported parameters
477 * contributor_details
481 ### statuses/retweet (POST,PUT; AUTH)
486 * include_entities: "true" shows entities for pictures and links (Default: false)
488 #### Unsupported parameters
494 ### statuses/show (*; AUTH)
499 * conversation: if set to "1" show all messages of the conversation with the given id
500 * include_entities: "true" shows entities for pictures and links (Default: false)
502 #### Unsupported parameters
509 ### statuses/update, statuses/update_with_media
513 * title: Title of the status
514 * status: Status in text format
515 * htmlstatus: Status in HTML format
516 * in_reply_to_status_id
520 * source: Application name
526 * include_entities: "true" shows entities for pictures and links (Default: false)
527 * media_ids: (By now only a single value, no array)
529 #### Unsupported parameters
533 * display_coordinates
537 ### statuses/user_timeline (*; AUTH)
541 * user_id: id of the user
542 * screen_name: screen name (for technical reasons, this value is not unique!)
543 * count: Items per page (default: 20)
545 * since_id: minimum id
547 * exclude_replies: don't show replies (default: false)
548 * conversation_id: Shows all statuses of a given conversation.
549 * include_entities: "true" shows entities for pictures and links (Default: false)
551 #### Unsupported parameters
555 * contributor_details
559 ### statusnet/config (*)
563 ### statusnet/conversation (*; AUTH)
565 It shows all direct answers (excluding the original post) to a given id.
570 * count: Items per page (default: 20)
572 * since_id: minimum id
574 * include_entities: "true" shows entities for pictures and links (Default: false)
578 ### statusnet/version (*)
580 #### Unsupported parameters
586 Friendica doesn't allow showing followers of other users.
595 * page: the page number (starting at 1) to return
596 * rpp: the number of statuses to return per page
597 * count: alias for the rpp parameter
598 * since_id: returns statuses with ids greater than the given id
599 * max_id: returns statuses with ids lower or equal to the given id
601 #### Unsupported parameters
612 ### search/tweets (*; AUTH)
614 This is an alias for `search`.
618 ### saved_searches/list (*; AUTH)
620 This call does not have any parameter.
628 * q: name of the user
630 #### Unsupported parameters
642 * user_id: id of the user
643 * screen_name: screen name (for technical reasons, this value is not unique!)
644 * include_entities: "true" shows entities for pictures and links (Default: false)
646 #### Unsupported parameters
652 Friendica doesn't allow showing friends of other users.
656 ### users/lookup (*; AUTH)
660 * user_id: list of ids to lookup
662 #### Unsupported parameters
669 ### account/update_profile_image (POST; AUTH)
673 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
674 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
676 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
682 * JSON return: returns the updated user details (see account/verify_credentials)
686 * 403 FORBIDDEN: if not authenticated
687 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
688 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
689 "image size exceeds Friendica Config setting (uploaded size: x)",
690 "unable to process image data",
691 "image upload failed"
695 ### account/update_profile (POST; AUTH)
699 * name (optional): full name of the user
700 * description (optional): a description of the user
702 #### Unsupported parameters
712 ### friendships/incoming (*; AUTH)
714 #### Unsupported parameters
719 ## Implemented API calls (not compatible with other APIs)
723 ### friendica/activity/[verb]
729 Add or remove an activity from an item.
730 'verb' can be one of:
738 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
739 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
740 Attend verbs should be used only with event-related items (there is no check at the moment)
758 ### friendica/group_show (*; AUTH)
760 Return all or a specified group of the user with the containing contacts as array.
764 * gid: optional, if not given, API returns all groups of the user
770 * name: name of the group
771 * gid: id of the group
772 * user: array of group members (return from api_get_user() function for each member)
776 ### friendica/group_delete (POST,DELETE; AUTH)
778 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
782 * gid: id of the group to be deleted
783 * name: name of the group to be deleted
789 * success: true if successfully deleted
790 * gid: gid of the deleted group
791 * name: name of the deleted group
792 * status: „deleted“ if successfully deleted
793 * wrong users: empty array
797 ### friendica/group_create (POST,PUT; AUTH)
799 Create the group with the posted array of contacts as members.
803 * name: name of the group to be created
807 JSON data as Array like the result of "users/group_show":
817 * success: true if successfully created or reactivated
818 * gid: gid of the created group
819 * name: name of the created group
820 * status: „missing user“ | „reactivated“ | „ok“
821 * wrong users: array of users, which were not available in the contact table
825 ### friendica/group_update (POST)
827 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).
831 * gid: id of the group to be changed
832 * name: name of the group to be changed
836 JSON data as array like the result of „users/group_show“:
846 * success: true if successfully updated
847 * gid: gid of the changed group
848 * name: name of the changed group
849 * status: „missing user“ | „ok“
850 * wrong users: array of users, which were not available in the contact table
854 ### friendica/notifications (GET)
856 Return last 50 notification for current user, ordered by date with unseen item on top
867 * type: type of notification as int (see NOTIFY_* constants in boot.php)
868 * name: full name of the contact subject of the note
869 * url: contact's profile url
870 * photo: contact's profile photo
871 * date: datetime string of the note
872 * timestamp: timestamp of the node
873 * date_rel: relative date of the note (eg. "1 hour ago")
874 * msg: note message in bbcode
875 * msg_html: note message in html
876 * msg_plain: note message in plain text
878 * seen: seen state: 0 or 1
882 ### friendica/notifications/seen (POST)
884 Set note as seen, returns item object if possible
888 id: id of the note to set seen
892 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
894 If the note is not linked to an item, a success status is returned:
896 * `success` (json) | `<status>success</status>` (xml)
900 ### friendica/photo (*; AUTH)
904 * photo_id: Resource id of a photo.
905 * scale: (optional) scale value of the photo
907 Returns data of a picture with the given resource.
908 If 'scale' isn't provided, returned data include full url to each scale of the photo.
909 If 'scale' is set, returned data include image data base64 encoded.
911 possibile scale value are:
913 * 0: original or max size by server settings
914 * 1: image with or height at <= 640
915 * 2: image with or height at <= 320
916 * 3: thumbnail 160x160
917 * 4: Profile image at 175x175
918 * 5: Profile image at 80x80
919 * 6: Profile image at 48x48
921 An image used as profile image has only scale 4-6, other images only 0-3
930 "created": "date(YYYY-MM-DD HH:MM:SS)",
931 "edited": "date(YYYY-MM-DD HH:MM:SS)",
932 "title": "photo title",
933 "desc": "photo description",
934 "album": "album name",
935 "filename": "original file name",
939 "profile": "1 if is profile photo",
941 "<scale>": "url to image"
945 "datasize": "size in byte",
946 "data": "base64 encoded image data"
955 <created>date(YYYY-MM-DD HH:MM:SS)</created>
956 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
957 <title>photo title</title>
958 <desc>photo description</desc>
959 <album>album name</album>
960 <filename>original file name</filename>
961 <type>mime type</type>
962 <height>number</height>
963 <width>number</width>
964 <profile>1 if is profile photo</profile>
966 <link type="mime type" scale="scale number" href="image url"/>
974 ### friendica/photos/list (*; AUTH)
976 Returns a list of all photo resources of the logged in user.
987 filename: "original file name",
988 type: "image mime type",
989 thumb: "url to thumb sized image"
998 <photos type="array">
999 <photo id="resource_id"
1001 filename="original file name"
1002 type="image mime type">
1003 "url to thumb sized image"
1011 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
1015 * album: name of the album to be deleted
1017 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
1023 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
1027 * 403 FORBIDDEN: if not authenticated
1028 * 400 BADREQUEST: "no albumname specified", "album not available"
1029 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1033 ### friendica/photoalbum/update (POST,PUT; AUTH)
1037 * album: name of the album to be updated
1038 * album_new: new name of the album
1040 changes the album name to album_new for all photos in album
1046 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1050 * 403 FORBIDDEN: if not authenticated
1051 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1052 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1056 ### friendica/photo/create (POST; AUTH)
1058 ### friendica/photo/update (POST; AUTH)
1062 * photo_id (optional): if specified the photo with this id will be updated
1063 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1064 * desc (optional): description for the photo, updated when photo_id is specified
1065 * album: name of the album to be deleted (always necessary)
1066 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1067 * 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;
1068 on update: keys need to be present with empty values for changing a private photo to public
1070 both calls point to one function for creating AND updating photos.
1071 Saves data for the scales 0-2 to database (see above for scale description).
1072 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1073 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.
1074 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.
1080 * new photo uploaded: JSON return with photo data (see friendica/photo)
1081 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1082 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1083 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1087 * 403 FORBIDDEN: if not authenticated
1088 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1089 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1090 "image size exceeds Friendica Config setting (uploaded size: x)",
1091 "unable to process image data",
1092 "image upload failed",
1093 "unknown error - uploading photo failed, see Friendica log for more information",
1094 "unknown error - update photo entry in database failed",
1095 "unknown error - this error on uploading or updating a photo should never happen"
1099 ### friendica/photo/delete (DELETE; AUTH)
1103 * photo_id: id of the photo to be deleted
1105 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1106 Sets item table entries for this photo to deleted = 1
1112 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1116 * 403 FORBIDDEN: if not authenticated
1117 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1118 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1122 ### friendica/direct_messages_setseen (GET; AUTH)
1126 * id: id of the message to be updated as seen
1132 * JSON return {"result":"ok","message":"message set to seen"}
1136 * different JSON returns {"result":"error","message":"xyz"}
1140 ### friendica/direct_messages_search (GET; AUTH)
1144 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1148 Returns only tested with JSON, XML might work as well.
1152 * JSON return {"success":"true","search_results": array of found messages}
1153 * JSOn return {"success":"false","search_results":"nothing found"}
1157 * different JSON returns {"result":"error","message":"searchstring not specified"}
1161 ### friendica/profile/show (GET; AUTH)
1163 show data of all profiles or a single profile of the authenticated user
1167 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1171 On success: Array of:
1173 * multi_profiles: true if user has activated multi_profiles
1174 * global_dir: URL of the global directory set in server settings
1175 * friendica_owner: user data of the authenticated user
1176 * profiles: array of the profile data
1179 HTTP 403 Forbidden: when no authentication was provided
1180 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1182 General description of profile data in API returns:
1186 * is_default: true if this is the public profile
1187 * hide_friends: true if friends are hidden
1190 * publish: true if published on the server's local directory
1191 * net_publish: true if published to global_dir
1192 * description ... homepage: different data fields from 'profile' table in database
1193 * users: array with the users allowed to view this profile (empty if is_default=true)
1197 ## Not Implemented API calls
1199 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1201 * statuses/retweets_of_me
1202 * friendships/create
1203 * friendships/destroy
1204 * friendships/exists
1206 * account/update_profile_background_image
1210 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1212 * statuses/mentions_timeline
1213 * statuses/retweets/:id
1215 * statuses/retweeters/ids
1217 * direct_messages/show
1218 * friendships/no_retweets/ids
1219 * friendships/outgoing
1220 * friendships/update
1222 * friendships/lookup
1224 * account/update_delivery_device
1228 * account/remove_profile_banner
1229 * account/update_profile_banner
1230 * users/profile_banner
1231 * mutes/users/create
1232 * mutes/users/destroy
1235 * users/suggestions/:slug
1237 * users/suggestions/:slug/members
1241 * lists/members/destroy
1244 * lists/subscribers/create
1245 * lists/subscribers/show
1246 * lists/subscribers/destroy
1247 * lists/members/create_all
1248 * lists/members/show
1250 * lists/members/create
1255 * lists/subscriptions
1256 * lists/members/destroy_all
1258 * saved_searches/show/:id
1259 * saved_searches/create
1260 * saved_searches/destroy/:id
1262 * geo/reverse_geocode
1267 * help/configuration
1283 /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"
1288 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1289 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1291 def tweet(server, message, group_allow=None):
1292 url = server + '/api/statuses/update'
1293 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1295 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.