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)
439 ### blocks/list (*; AUTH)
443 * include_entities: "true" shows entities for pictures and links (Default: false)
444 * count: Items per page (default: 20).
447 #### Unsupported parameters
454 ### statuses/friends_timeline (*; AUTH)
458 * count: Items per page (default: 20)
460 * since_id: minimum id
462 * exclude_replies: don't show replies (default: false)
463 * conversation_id: Shows all statuses of a given conversation.
464 * include_entities: "true" shows entities for pictures and links (Default: false)
466 #### Unsupported parameters
470 * contributor_details
474 ### statuses/home_timeline (*; AUTH)
478 * count: Items per page (default: 20)
480 * since_id: minimum id
482 * exclude_replies: don't show replies (default: false)
483 * conversation_id: Shows all statuses of a given conversation.
484 * include_entities: "true" shows entities for pictures and links (Default: false)
486 #### Unsupported parameters
490 * contributor_details
494 ### statuses/mentions (*; AUTH)
498 * count: Items per page (default: 20)
500 * since_id: minimum id
502 * include_entities: "true" shows entities for pictures and links (Default: false)
504 #### Unsupported parameters
508 * contributor_details
512 ### statuses/public_timeline (*; AUTH)
516 * count: Items per page (default: 20)
518 * since_id: minimum id
520 * exclude_replies: don't show replies (default: false)
521 * conversation_id: Shows all statuses of a given conversation.
522 * include_entities: "true" shows entities for pictures and links (Default: false)
524 #### Unsupported parameters
530 ### statuses/networkpublic_timeline (*; AUTH)
534 * count: Items per page (default: 20)
536 * since_id: minimum id
538 * include_entities: "true" shows entities for pictures and links (Default: false)
542 ### statuses/replies (*; AUTH)
546 * count: Items per page (default: 20)
548 * since_id: minimum id
550 * include_entities: "true" shows entities for pictures and links (Default: false)
552 #### Unsupported parameters
556 * contributor_details
560 ### statuses/retweet (POST,PUT; AUTH)
565 * include_entities: "true" shows entities for pictures and links (Default: false)
567 #### Unsupported parameters
573 ### statuses/show (*; AUTH)
578 * conversation: if set to "1" show all messages of the conversation with the given id
579 * include_entities: "true" shows entities for pictures and links (Default: false)
581 #### Unsupported parameters
588 ### statuses/update, statuses/update_with_media
592 * title: Title of the status
593 * status: Status in text format
594 * htmlstatus: Status in HTML format
595 * in_reply_to_status_id
599 * source: Application name
605 * include_entities: "true" shows entities for pictures and links (Default: false)
606 * media_ids: (By now only a single value, no array)
608 #### Unsupported parameters
612 * display_coordinates
616 ### statuses/user_timeline (*; AUTH)
620 * user_id: id of the user
621 * screen_name: screen name (for technical reasons, this value is not unique!)
622 * count: Items per page (default: 20)
624 * since_id: minimum id
626 * exclude_replies: don't show replies (default: false)
627 * conversation_id: Shows all statuses of a given conversation.
628 * include_entities: "true" shows entities for pictures and links (Default: false)
630 #### Unsupported parameters
634 * contributor_details
638 ### statusnet/config (*)
642 ### statusnet/conversation (*; AUTH)
644 It shows all direct answers (excluding the original post) to a given id.
649 * count: Items per page (default: 20)
651 * since_id: minimum id
653 * include_entities: "true" shows entities for pictures and links (Default: false)
657 ### statusnet/version (*)
659 #### Unsupported parameters
665 Friendica doesn't allow showing followers of other users.
674 * page: the page number (starting at 1) to return
675 * rpp: the number of statuses to return per page
676 * count: alias for the rpp parameter
677 * since_id: returns statuses with ids greater than the given id
678 * max_id: returns statuses with ids lower or equal to the given id
680 #### Unsupported parameters
691 ### search/tweets (*; AUTH)
693 This is an alias for `search`.
697 ### saved_searches/list (*; AUTH)
699 This call does not have any parameter.
707 * q: name of the user
709 #### Unsupported parameters
721 * user_id: id of the user
722 * screen_name: screen name (for technical reasons, this value is not unique!)
723 * include_entities: "true" shows entities for pictures and links (Default: false)
725 #### Unsupported parameters
731 Friendica doesn't allow showing friends of other users.
735 ### users/lookup (*; AUTH)
739 * user_id: list of ids to lookup
741 #### Unsupported parameters
748 ### account/update_profile_image (POST; AUTH)
752 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
753 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
755 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
761 * JSON return: returns the updated user details (see account/verify_credentials)
765 * 403 FORBIDDEN: if not authenticated
766 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
767 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
768 "image size exceeds Friendica Config setting (uploaded size: x)",
769 "unable to process image data",
770 "image upload failed"
774 ### account/update_profile (POST; AUTH)
778 * name (optional): full name of the user
779 * description (optional): a description of the user
781 #### Unsupported parameters
791 ### friendships/incoming (*; AUTH)
793 #### Unsupported parameters
798 ## Implemented API calls (not compatible with other APIs)
802 ### friendica/activity/[verb]
808 Add or remove an activity from an item.
809 'verb' can be one of:
817 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
818 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
819 Attend verbs should be used only with event-related items (there is no check at the moment)
837 ### friendica/group_show (*; AUTH)
839 Return all or a specified group of the user with the containing contacts as array.
843 * gid: optional, if not given, API returns all groups of the user
849 * name: name of the group
850 * gid: id of the group
851 * user: array of group members (return from api_get_user() function for each member)
855 ### friendica/group_delete (POST,DELETE; AUTH)
857 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
861 * gid: id of the group to be deleted
862 * name: name of the group to be deleted
868 * success: true if successfully deleted
869 * gid: gid of the deleted group
870 * name: name of the deleted group
871 * status: „deleted“ if successfully deleted
872 * wrong users: empty array
876 ### friendica/group_create (POST,PUT; AUTH)
878 Create the group with the posted array of contacts as members.
882 * name: name of the group to be created
886 JSON data as Array like the result of "users/group_show":
896 * success: true if successfully created or reactivated
897 * gid: gid of the created group
898 * name: name of the created group
899 * status: „missing user“ | „reactivated“ | „ok“
900 * wrong users: array of users, which were not available in the contact table
904 ### friendica/group_update (POST)
906 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).
910 * gid: id of the group to be changed
911 * name: name of the group to be changed
915 JSON data as array like the result of „users/group_show“:
925 * success: true if successfully updated
926 * gid: gid of the changed group
927 * name: name of the changed group
928 * status: „missing user“ | „ok“
929 * wrong users: array of users, which were not available in the contact table
933 ### friendica/notifications (GET)
935 Return last 50 notification for current user, ordered by date with unseen item on top
946 * type: type of notification as int (see NOTIFY_* constants in boot.php)
947 * name: full name of the contact subject of the note
948 * url: contact's profile url
949 * photo: contact's profile photo
950 * date: datetime string of the note
951 * timestamp: timestamp of the node
952 * date_rel: relative date of the note (eg. "1 hour ago")
953 * msg: note message in bbcode
954 * msg_html: note message in html
955 * msg_plain: note message in plain text
957 * seen: seen state: 0 or 1
961 ### friendica/notifications/seen (POST)
963 Set note as seen, returns item object if possible
967 id: id of the note to set seen
971 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
973 If the note is not linked to an item, a success status is returned:
975 * `success` (json) | `<status>success</status>` (xml)
979 ### friendica/photo (*; AUTH)
983 * photo_id: Resource id of a photo.
984 * scale: (optional) scale value of the photo
986 Returns data of a picture with the given resource.
987 If 'scale' isn't provided, returned data include full url to each scale of the photo.
988 If 'scale' is set, returned data include image data base64 encoded.
990 possibile scale value are:
992 * 0: original or max size by server settings
993 * 1: image with or height at <= 640
994 * 2: image with or height at <= 320
995 * 3: thumbnail 160x160
996 * 4: Profile image at 175x175
997 * 5: Profile image at 80x80
998 * 6: Profile image at 48x48
1000 An image used as profile image has only scale 4-6, other images only 0-3
1009 "created": "date(YYYY-MM-DD HH:MM:SS)",
1010 "edited": "date(YYYY-MM-DD HH:MM:SS)",
1011 "title": "photo title",
1012 "desc": "photo description",
1013 "album": "album name",
1014 "filename": "original file name",
1015 "type": "mime type",
1018 "profile": "1 if is profile photo",
1020 "<scale>": "url to image"
1023 // if 'scale' is set
1024 "datasize": "size in byte",
1025 "data": "base64 encoded image data"
1034 <created>date(YYYY-MM-DD HH:MM:SS)</created>
1035 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
1036 <title>photo title</title>
1037 <desc>photo description</desc>
1038 <album>album name</album>
1039 <filename>original file name</filename>
1040 <type>mime type</type>
1041 <height>number</height>
1042 <width>number</width>
1043 <profile>1 if is profile photo</profile>
1044 <links type="array">
1045 <link type="mime type" scale="scale number" href="image url"/>
1053 ### friendica/photos/list (*; AUTH)
1055 Returns a list of all photo resources of the logged in user.
1065 album: "album name",
1066 filename: "original file name",
1067 type: "image mime type",
1068 thumb: "url to thumb sized image"
1077 <photos type="array">
1078 <photo id="resource_id"
1080 filename="original file name"
1081 type="image mime type">
1082 "url to thumb sized image"
1090 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
1094 * album: name of the album to be deleted
1096 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
1102 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
1106 * 403 FORBIDDEN: if not authenticated
1107 * 400 BADREQUEST: "no albumname specified", "album not available"
1108 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1112 ### friendica/photoalbum/update (POST,PUT; AUTH)
1116 * album: name of the album to be updated
1117 * album_new: new name of the album
1119 changes the album name to album_new for all photos in album
1125 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1129 * 403 FORBIDDEN: if not authenticated
1130 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1131 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1135 ### friendica/photo/create (POST; AUTH)
1137 ### friendica/photo/update (POST; AUTH)
1141 * photo_id (optional): if specified the photo with this id will be updated
1142 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1143 * desc (optional): description for the photo, updated when photo_id is specified
1144 * album: name of the album to be deleted (always necessary)
1145 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1146 * 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;
1147 on update: keys need to be present with empty values for changing a private photo to public
1149 both calls point to one function for creating AND updating photos.
1150 Saves data for the scales 0-2 to database (see above for scale description).
1151 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1152 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.
1153 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.
1159 * new photo uploaded: JSON return with photo data (see friendica/photo)
1160 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1161 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1162 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1166 * 403 FORBIDDEN: if not authenticated
1167 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1168 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1169 "image size exceeds Friendica Config setting (uploaded size: x)",
1170 "unable to process image data",
1171 "image upload failed",
1172 "unknown error - uploading photo failed, see Friendica log for more information",
1173 "unknown error - update photo entry in database failed",
1174 "unknown error - this error on uploading or updating a photo should never happen"
1178 ### friendica/photo/delete (DELETE; AUTH)
1182 * photo_id: id of the photo to be deleted
1184 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1185 Sets item table entries for this photo to deleted = 1
1191 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1195 * 403 FORBIDDEN: if not authenticated
1196 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1197 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1201 ### friendica/direct_messages_setseen (GET; AUTH)
1205 * id: id of the message to be updated as seen
1211 * JSON return {"result":"ok","message":"message set to seen"}
1215 * different JSON returns {"result":"error","message":"xyz"}
1219 ### friendica/direct_messages_search (GET; AUTH)
1223 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1227 Returns only tested with JSON, XML might work as well.
1231 * JSON return {"success":"true","search_results": array of found messages}
1232 * JSOn return {"success":"false","search_results":"nothing found"}
1236 * different JSON returns {"result":"error","message":"searchstring not specified"}
1240 ### friendica/profile/show (GET; AUTH)
1242 show data of all profiles or a single profile of the authenticated user
1246 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1250 On success: Array of:
1252 * multi_profiles: true if user has activated multi_profiles
1253 * global_dir: URL of the global directory set in server settings
1254 * friendica_owner: user data of the authenticated user
1255 * profiles: array of the profile data
1258 HTTP 403 Forbidden: when no authentication was provided
1259 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1261 General description of profile data in API returns:
1265 * is_default: true if this is the public profile
1266 * hide_friends: true if friends are hidden
1269 * publish: true if published on the server's local directory
1270 * net_publish: true if published to global_dir
1271 * description ... homepage: different data fields from 'profile' table in database
1272 * users: array with the users allowed to view this profile (empty if is_default=true)
1276 ## Not Implemented API calls
1278 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1280 * statuses/retweets_of_me
1281 * friendships/create
1282 * friendships/destroy
1283 * friendships/exists
1285 * account/update_profile_background_image
1289 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1291 * statuses/mentions_timeline
1292 * statuses/retweets/:id
1294 * statuses/retweeters/ids
1296 * direct_messages/show
1297 * friendships/no_retweets/ids
1298 * friendships/outgoing
1299 * friendships/update
1301 * friendships/lookup
1303 * account/update_delivery_device
1307 * account/remove_profile_banner
1308 * account/update_profile_banner
1309 * users/profile_banner
1310 * mutes/users/create
1311 * mutes/users/destroy
1314 * users/suggestions/:slug
1316 * users/suggestions/:slug/members
1319 * lists/members/destroy
1322 * lists/subscribers/create
1323 * lists/subscribers/show
1324 * lists/subscribers/destroy
1325 * lists/members/create_all
1326 * lists/members/show
1328 * lists/members/create
1330 * lists/subscriptions
1331 * lists/members/destroy_all
1332 * saved_searches/show/:id
1333 * saved_searches/create
1334 * saved_searches/destroy/:id
1336 * geo/reverse_geocode
1341 * help/configuration
1357 /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"
1362 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1363 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1365 def tweet(server, message, group_allow=None):
1366 url = server + '/api/statuses/update'
1367 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1369 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.