doc/api.md

   1 # Friendica API
   2
   3 <!-- markdownlint-disable MD010 MD013 MD024 -->
   4
   5 * [Home](help)
   6
   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).
   8
   9 Please refer to the linked documentation for further information.
  10
  11 ## Implemented API calls
  12
  13 ### General
  14
  15 #### HTTP Method
  16
  17 API endpoints can restrict the method used to request them.
  18 Using an invalid method results in HTTP error 405 "Method Not Allowed".
  19
  20 In this document, the required method is listed after the endpoint name. "*" means every method can be used.
  21
  22 #### Auth
  23
  24 Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.
  25
  26 OAuth settings can be added by the user in web UI under /settings/oauth/
  27
  28 In this document, endpoints which requires auth are marked with "AUTH" after endpoint name
  29
  30 #### Unsupported parameters
  31
  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
  37 * include_rts: To-Do
  38 * include_my_retweet: Retweets in Friendica are implemented in a different way
  39
  40 #### Different behaviour
  41
  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.
  44
  45 #### Return values
  46
  47 * cid: Contact id of the user (important for "contact_allow" and "contact_deny")
  48 * network: network of the user
  49
  50 #### Errors
  51
  52 When an error occurs in API call, an HTTP error code is returned, with an error message
  53 Usually:
  54
  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
  60
  61 Error body is
  62
  63 json:
  64
  65 ```json
  66         {
  67                 "error": "Specific error message",
  68                 "request": "API path requested",
  69                 "code": "HTTP error code"
  70         }
  71 ```
  72
  73 xml:
  74
  75 ```xml
  76         <status>
  77                 <error>Specific error message</error>
  78                 <request>API path requested</request>
  79                 <code>HTTP error code</code>
  80         </status>
  81 ```
  82
  83 ---
  84
  85 ### account/rate_limit_status (*; AUTH)
  86
  87 ---
  88
  89 ### account/verify_credentials (*; AUTH)
  90
  91 #### Parameters
  92
  93 * skip_status: Don't show the "status" field. (Default: false)
  94 * include_entities: "true" shows entities for pictures and links (Default: false)
  95
  96 ---
  97
  98 ### conversation/show (*; AUTH)
  99
 100 Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
 101
 102 #### Parameter
 103
 104 * id: id of the post
 105 * count: Items per page (default: 20)
 106 * page: page number
 107 * since_id: minimum id
 108 * max_id: maximum id
 109 * include_entities: "true" shows entities for pictures and links (Default: false)
 110
 111 #### Unsupported parameters
 112
 113 * include_rts
 114 * trim_user
 115 * contributor_details
 116
 117 ---
 118
 119 ### direct_messages (*; AUTH)
 120
 121 #### Parameters
 122
 123 * count: Items per page (default: 20)
 124 * page: page number
 125 * since_id: minimum id
 126 * max_id: maximum 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")
 130
 131 #### Unsupported parameters
 132
 133 * skip_status
 134
 135 ---
 136
 137 ### direct_messages/all (*; AUTH)
 138
 139 #### Parameters
 140
 141 * count: Items per page (default: 20)
 142 * page: page number
 143 * since_id: minimum id
 144 * max_id: maximum 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")
 147
 148 ---
 149
 150 ### direct_messages/conversation (*; AUTH)
 151
 152 Shows all direct messages of a conversation
 153
 154 #### Parameters
 155
 156 * count: Items per page (default: 20)
 157 * page: page number
 158 * since_id: minimum id
 159 * max_id: maximum 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")
 163
 164 ---
 165
 166 ### direct_messages/sent (*; AUTH)
 167
 168 #### Parameters
 169
 170 * count: Items per page (default: 20)
 171 * page: page number
 172 * since_id: minimum id
 173 * max_id: maximum 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")
 177
 178 ---
 179
 180 ### direct_messages/new (POST,PUT; AUTH)
 181
 182 #### Parameters
 183
 184 * user_id: id of the user
 185 * screen_name: screen name (for technical reasons, this value is not unique!)
 186 * text: The message
 187 * replyto: ID of the replied direct message
 188 * title: Title of the direct message
 189
 190 ---
 191
 192 ### direct_messages/destroy (POST,DELETE; AUTH)
 193
 194 #### Parameters
 195
 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")
 200
 201 #### Return values
 202
 203 On success:
 204
 205 * JSON return as defined for Twitter API not yet implemented
 206 * on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
 207
 208 On error:
 209 HTTP 400 BadRequest
 210
 211 * on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
 212
 213 ---
 214
 215 ### externalprofile/show (*)
 216
 217 #### Parameters
 218
 219 * profileurl: profile url
 220
 221 ---
 222
 223 ### favorites (*; AUTH)
 224
 225 #### Parameters
 226
 227 * count: Items per page (default: 20)
 228 * page: page number
 229 * since_id: minimum id
 230 * max_id: maximum id
 231 * include_entities: "true" shows entities for pictures and links (Default: false)
 232
 233 #### Unsupported parameters
 234
 235 * user_id
 236 * screen_name
 237
 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.
 240
 241 ---
 242
 243 ### favorites/create (POST,PUT; AUTH)
 244
 245 #### Parameters
 246
 247 * id
 248 * include_entities: "true" shows entities for pictures and links (Default: false)
 249
 250 ---
 251
 252 ### favorites/destroy (POST,DELETE; AUTH)
 253
 254 #### Parameters
 255
 256 * id
 257 * include_entities: "true" shows entities for pictures and links (Default: false)
 258
 259 ---
 260
 261 ### followers/ids (*; AUTH)
 262
 263 #### Parameters
 264
 265 * stringify_ids: Send id numbers as text (true) or integers (false)? (default: false)
 266
 267 #### Unsupported parameters
 268
 269 * user_id
 270 * screen_name
 271 * cursor
 272
 273 Friendica doesn't allow showing the followers of other users.
 274
 275 ---
 276
 277 ### friends/ids (*; AUTH)
 278
 279 #### Parameters
 280
 281 * stringify_ids: Send the id numbers as text (true) or integers (false)? (default: false)
 282
 283 #### Unsupported parameters
 284
 285 * user_id
 286 * screen_name
 287 * cursor
 288
 289 Friendica doesn't allow showing the friends of other users.
 290
 291 ---
 292
 293 ### help/test (*)
 294
 295 ---
 296
 297 ### lists/ownerships (*; AUTH)
 298
 299 #### Parameters
 300
 301 * list_id: ID of the list
 302 * count: Items per page
 303 * page: Page number
 304 * since_id: Minimum ID
 305 * max_id: Maximum ID
 306
 307 #### Unsupported parameters
 308
 309 * slug
 310 * owner_screen_name
 311 * owner_id
 312 * include_entities
 313 * include_rts
 314
 315 ---
 316
 317 ### lists/destroy (POST; AUTH)
 318
 319 #### Parameters
 320
 321 * list_id: ID of the list
 322
 323 #### Unsupported parameters
 324
 325 * owner_screen_name
 326 * owner_id
 327 * slug
 328
 329 ---
 330
 331 ### lists/create (POST; AUTH)
 332
 333 #### Parameters
 334
 335 * name: name of the list
 336
 337 #### Unsupported parameters
 338
 339 * mode
 340 * description
 341
 342 ---
 343
 344 ### lists/update (POST; AUTH)
 345
 346 #### Parameters
 347
 348 * list_id: ID of the list
 349 * name: name of the list
 350
 351 #### Unsupported parameters
 352
 353 * slug
 354 * name
 355 * mode
 356 * description
 357 * owner_screen_name
 358 * owner_id
 359
 360 ---
 361
 362 ### lists/statuses (*; AUTH)
 363
 364 #### Parameters
 365
 366 * user_id: ID of the user for whom to return results.
 367
 368 #### Unsupported parameters
 369
 370 * screen_name
 371 * count
 372 * cursor
 373
 374 ---
 375
 376 ### media/upload (POST,PUT; AUTH)
 377
 378 #### Parameters
 379
 380 * media: image data
 381
 382 #### Return values
 383
 384 Object of:
 385
 386 * media_id: a media identifier (integer)
 387 * media_id_string: a media identifier (string)
 388 * size: size in byte
 389 * image.w: image width
 390 * image.h: image height
 391 * image.image_type: image mime type
 392 * image.friendica_preview_url: image preview url
 393
 394 ---
 395
 396 ### oauth/request_token (*)
 397
 398 #### Parameters
 399
 400 * oauth_callback
 401
 402 #### Unsupported parameters
 403
 404 * x_auth_access_type
 405
 406 ---
 407
 408 ### oauth/access_token (*)
 409
 410 #### Parameters
 411
 412 * oauth_verifier
 413
 414 #### Unsupported parameters
 415
 416 * x_auth_password
 417 * x_auth_username
 418 * x_auth_mode
 419
 420 ---
 421
 422 ### statuses/destroy (POST,DELETE; AUTH)
 423
 424 #### Parameters
 425
 426 * id: message number
 427 * include_entities: "true" shows entities for pictures and links (Default: false)
 428
 429 #### Unsupported parameters
 430
 431 * trim_user
 432
 433 ---
 434
 435 ### statuses/followers (*; AUTH)
 436
 437 #### Parameters
 438
 439 * include_entities: "true" shows entities for pictures and links (Default: false)
 440
 441 ---
 442
 443 ### statuses/friends (*; AUTH)
 444
 445 #### Parameters
 446
 447 * include_entities: "true" shows entities for pictures and links (Default: false)
 448 * count: how many items should be shown (Default: 20)
 449
 450 ---
 451
 452 ### blocks/list (*; AUTH)
 453
 454 #### Parameters
 455
 456 * include_entities: "true" shows entities for pictures and links (Default: false)
 457 * count: Items per page (default: 20).
 458 * page: page number
 459
 460 #### Unsupported parameters
 461
 462 * cursor
 463 * skip_status
 464
 465 ---
 466
 467 ### statuses/friends_timeline (*; AUTH)
 468
 469 #### Parameters
 470
 471 * count: Items per page (default: 20)
 472 * page: page number
 473 * since_id: minimum id
 474 * max_id: maximum id
 475 * exclude_replies: don't show replies (default: false)
 476 * conversation_id: Shows all statuses of a given conversation.
 477 * include_entities: "true" shows entities for pictures and links (Default: false)
 478
 479 #### Unsupported parameters
 480
 481 * include_rts
 482 * trim_user
 483 * contributor_details
 484
 485 ---
 486
 487 ### statuses/home_timeline (*; AUTH)
 488
 489 #### Parameters
 490
 491 * count: Items per page (default: 20)
 492 * page: page number
 493 * since_id: minimum id
 494 * max_id: maximum id
 495 * exclude_replies: don't show replies (default: false)
 496 * conversation_id: Shows all statuses of a given conversation.
 497 * include_entities: "true" shows entities for pictures and links (Default: false)
 498
 499 #### Unsupported parameters
 500
 501 * include_rts
 502 * trim_user
 503 * contributor_details
 504
 505 ---
 506
 507 ### statuses/mentions (*; AUTH)
 508
 509 #### Parameters
 510
 511 * count: Items per page (default: 20)
 512 * page: page number
 513 * since_id: minimum id
 514 * max_id: maximum id
 515 * include_entities: "true" shows entities for pictures and links (Default: false)
 516
 517 #### Unsupported parameters
 518
 519 * include_rts
 520 * trim_user
 521 * contributor_details
 522
 523 ---
 524
 525 ### statuses/public_timeline (*; AUTH)
 526
 527 #### Parameters
 528
 529 * count: Items per page (default: 20)
 530 * page: page number
 531 * since_id: minimum id
 532 * max_id: maximum id
 533 * exclude_replies: don't show replies (default: false)
 534 * conversation_id: Shows all statuses of a given conversation.
 535 * include_entities: "true" shows entities for pictures and links (Default: false)
 536
 537 #### Unsupported parameters
 538
 539 * trim_user
 540
 541 ---
 542
 543 ### statuses/networkpublic_timeline (*; AUTH)
 544
 545 #### Parameters
 546
 547 * count: Items per page (default: 20)
 548 * page: page number
 549 * since_id: minimum id
 550 * max_id: maximum id
 551 * include_entities: "true" shows entities for pictures and links (Default: false)
 552
 553 ---
 554
 555 ### statuses/replies (*; AUTH)
 556
 557 #### Parameters
 558
 559 * count: Items per page (default: 20)
 560 * page: page number
 561 * since_id: minimum id
 562 * max_id: maximum id
 563 * include_entities: "true" shows entities for pictures and links (Default: false)
 564
 565 #### Unsupported parameters
 566
 567 * include_rts
 568 * trim_user
 569 * contributor_details
 570
 571 ---
 572
 573 ### statuses/retweet (POST,PUT; AUTH)
 574
 575 #### Parameters
 576
 577 * id: message number
 578 * include_entities: "true" shows entities for pictures and links (Default: false)
 579
 580 #### Unsupported parameters
 581
 582 * trim_user
 583
 584 ---
 585
 586 ### statuses/show (*; AUTH)
 587
 588 #### Parameters
 589
 590 * id: message number
 591 * conversation: if set to "1" show all messages of the conversation with the given id
 592 * include_entities: "true" shows entities for pictures and links (Default: false)
 593
 594 #### Unsupported parameters
 595
 596 * include_my_retweet
 597 * trim_user
 598
 599 ---
 600
 601 ### statuses/update, statuses/update_with_media
 602
 603 #### Parameters
 604
 605 * title: Title of the status
 606 * status: Status in text format
 607 * htmlstatus: Status in HTML format
 608 * in_reply_to_status_id
 609 * lat: latitude
 610 * long: longitude
 611 * media: image data
 612 * source: Application name
 613 * group_allow
 614 * contact_allow
 615 * group_deny
 616 * contact_deny
 617 * network
 618 * include_entities: "true" shows entities for pictures and links (Default: false)
 619 * media_ids: (By now only a single value, no array)
 620
 621 #### Unsupported parameters
 622
 623 * trim_user
 624 * place_id
 625 * display_coordinates
 626
 627 ---
 628
 629 ### statuses/user_timeline (*; AUTH)
 630
 631 #### Parameters
 632
 633 * user_id: id of the user
 634 * screen_name: screen name (for technical reasons, this value is not unique!)
 635 * count: Items per page (default: 20)
 636 * page: page number
 637 * since_id: minimum id
 638 * max_id: maximum id
 639 * exclude_replies: don't show replies (default: false)
 640 * conversation_id: Shows all statuses of a given conversation.
 641 * include_entities: "true" shows entities for pictures and links (Default: false)
 642
 643 #### Unsupported parameters
 644
 645 * include_rts
 646 * trim_user
 647 * contributor_details
 648
 649 ---
 650
 651 ### Return values for statuses/* api calls
 652
 653 Returned status object is conform to GNU Social/Twitter api.
 654
 655 Friendica adds some addictional fields:
 656
 657 - owner: a user object, it's the owner of the item.
 658 - private: boolean, true if the item is marked as private
 659 - activities: map with activities related to the item. Every activity is a list of user objects.
 660
 661 This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses
 662
 663 JSON:
 664
 665 ```json
 666 [
 667         {
 668                 // ...
 669                 'friendica_owner' : {
 670                         // user object
 671                 },
 672                 'friendica_private' : true,
 673                 'friendica_activities': {
 674                         'like': [
 675                                 {
 676                                         // user object
 677                                 },
 678                                 // ...
 679                         ],
 680                         'dislike': [],
 681                         'attendyes': [],
 682                         'attendno': [],
 683                         'attendmaybe': []
 684                 }
 685         },
 686         // ...
 687 ]
 688 ```
 689
 690 XML:
 691
 692 ```xml
 693 <statuses xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" xmlns:friendica="http://friendi.ca/schema/api/1/" xmlns:georss="http://www.georss.org/georss">
 694   <status>
 695         <!-- ... -->
 696         <friendica:owner><!-- user object --></friendica:owner>
 697         <friendica:private>true</friendica:private>
 698         <friendica:activities>
 699                 <friendica:like>
 700                 <user>
 701                         <!-- user object -->
 702                 </user>
 703                 <!-- ... --->
 704                 </friendica:like>
 705                 <friendica:dislike/>
 706                 <friendica:attendyes/>
 707                 <friendica:attendno/>
 708                 <friendica:attendmaybe/>
 709         </friendica:activities>
 710         </status>
 711         <!-- ... -->
 712 </statuses>
 713 ```
 714
 715
 716 ---
 717
 718 ### statusnet/config (*)
 719
 720 ---
 721
 722 ### statusnet/conversation (*; AUTH)
 723
 724 It shows all direct answers (excluding the original post) to a given id.
 725
 726 #### Parameter
 727
 728 * id: id of the post
 729 * count: Items per page (default: 20)
 730 * page: page number
 731 * since_id: minimum id
 732 * max_id: maximum id
 733 * include_entities: "true" shows entities for pictures and links (Default: false)
 734
 735 ---
 736
 737 ### statusnet/version (*)
 738
 739 #### Unsupported parameters
 740
 741 * user_id
 742 * screen_name
 743 * cursor
 744
 745 Friendica doesn't allow showing followers of other users.
 746
 747 ---
 748
 749 ### search (*; AUTH)
 750
 751 #### Parameters
 752
 753 * q: search query
 754 * page: the page number (starting at 1) to return
 755 * rpp: the number of statuses to return per page
 756 * count: alias for the rpp parameter
 757 * since_id: returns statuses with ids greater than the given id
 758 * max_id: returns statuses with ids lower or equal to the given id
 759
 760 #### Unsupported parameters
 761
 762 * geocode
 763 * lang
 764 * locale
 765 * result_type
 766 * until
 767 * include_entities
 768
 769 ---
 770
 771 ### search/tweets (*; AUTH)
 772
 773 This is an alias for `search`.
 774
 775 ---
 776
 777 ### saved_searches/list (*; AUTH)
 778
 779 This call does not have any parameter.
 780
 781 ---
 782
 783 ### users/search (*)
 784
 785 #### Parameters
 786
 787 * q: name of the user
 788
 789 #### Unsupported parameters
 790
 791 * page
 792 * count
 793 * include_entities
 794
 795 ---
 796
 797 ### users/show (*)
 798
 799 #### Parameters
 800
 801 * user_id: id of the user
 802 * screen_name: screen name (for technical reasons, this value is not unique!)
 803 * include_entities: "true" shows entities for pictures and links (Default: false)
 804
 805 #### Unsupported parameters
 806
 807 * user_id
 808 * screen_name
 809 * cursor
 810
 811 Friendica doesn't allow showing friends of other users.
 812
 813 ---
 814
 815 ### users/lookup (*; AUTH)
 816
 817 #### Parameters
 818
 819 * user_id: list of ids to lookup
 820
 821 #### Unsupported parameters
 822
 823 * screen_name
 824 * include_entities
 825
 826 ---
 827
 828 ### account/update_profile_image (POST; AUTH)
 829
 830 #### Parameters
 831
 832 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
 833 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
 834
 835 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
 836
 837 #### Return values
 838
 839 On success:
 840
 841 * JSON return: returns the updated user details (see account/verify_credentials)
 842
 843 On error:
 844
 845 * 403 FORBIDDEN: if not authenticated
 846 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
 847 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
 848                         "image size exceeds Friendica Config setting (uploaded size: x)",
 849                         "unable to process image data",
 850                         "image upload failed"
 851
 852 ---
 853
 854 ### account/update_profile (POST; AUTH)
 855
 856 #### Parameters
 857
 858 * name (optional): full name of the user
 859 * description (optional): a description of the user
 860
 861 #### Unsupported parameters
 862
 863 * url
 864 * location
 865 * profile_link_color
 866 * include_entities
 867 * skip_status
 868
 869 ---
 870
 871 ### friendships/incoming (*; AUTH)
 872
 873 #### Unsupported parameters
 874
 875 * cursor
 876 * stringify_ids
 877
 878 ## Implemented API calls (not compatible with other APIs)
 879
 880 ---
 881
 882 ### friendica/activity/[verb]
 883
 884 #### parameters
 885
 886 * id: item id
 887
 888 Add or remove an activity from an item.
 889 'verb' can be one of:
 890
 891 * like
 892 * dislike
 893 * attendyes
 894 * attendno
 895 * attendmaybe
 896
 897 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
 898 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
 899 Attend verbs should be used only with event-related items (there is no check at the moment)
 900
 901 #### Return values
 902
 903 On success:
 904 json:
 905
 906 ```"ok"```
 907
 908 xml:
 909
 910 ```<ok>true</ok>```
 911
 912 On error:
 913 HTTP 400 BadRequest
 914
 915 ---
 916
 917 ### friendica/group_show (*; AUTH)
 918
 919 Return all or a specified group of the user with the containing contacts as array.
 920
 921 #### Parameters
 922
 923 * gid: optional, if not given, API returns all groups of the user
 924
 925 #### Return values
 926
 927 Array of:
 928
 929 * name: name of the group
 930 * gid: id of the group
 931 * user: array of group members (return from api_get_user() function for each member)
 932
 933 ---
 934
 935 ### friendica/group_delete (POST,DELETE; AUTH)
 936
 937 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
 938
 939 #### Parameters
 940
 941 * gid: id of the group to be deleted
 942 * name: name of the group to be deleted
 943
 944 #### Return values
 945
 946 Array of:
 947
 948 * success: true if successfully deleted
 949 * gid: gid of the deleted group
 950 * name: name of the deleted group
 951 * status: „deleted“ if successfully deleted
 952 * wrong users: empty array
 953
 954 ---
 955
 956 ### friendica/group_create (POST,PUT; AUTH)
 957
 958 Create the group with the posted array of contacts as members.
 959
 960 #### Parameters
 961
 962 * name: name of the group to be created
 963
 964 #### POST data
 965
 966 JSON data as Array like the result of "users/group_show":
 967
 968 * gid
 969 * name
 970 * array of users
 971
 972 #### Return values
 973
 974 Array of:
 975
 976 * success: true if successfully created or reactivated
 977 * gid: gid of the created group
 978 * name: name of the created group
 979 * status: „missing user“ | „reactivated“ | „ok“
 980 * wrong users: array of users, which were not available in the contact table
 981
 982 ---
 983
 984 ### friendica/group_update (POST)
 985
 986 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).
 987
 988 #### Parameters
 989
 990 * gid: id of the group to be changed
 991 * name: name of the group to be changed
 992
 993 #### POST data
 994
 995 JSON data as array like the result of „users/group_show“:
 996
 997 * gid
 998 * name
 999 * array of users
1000
1001 #### Return values
1002
1003 Array of:
1004
1005 * success: true if successfully updated
1006 * gid: gid of the changed group
1007 * name: name of the changed group
1008 * status: „missing user“ | „ok“
1009 * wrong users: array of users, which were not available in the contact table
1010
1011 ---
1012
1013 ### friendica/notifications (GET)
1014
1015 Return last 50 notification for current user, ordered by date with unseen item on top
1016
1017 #### Parameters
1018
1019 none
1020
1021 #### Return values
1022
1023 Array of:
1024
1025 * id: id of the note
1026 * type: type of notification as int (see NOTIFY_* constants in boot.php)
1027 * name: full name of the contact subject of the note
1028 * url: contact's profile url
1029 * photo: contact's profile photo
1030 * date: datetime string of the note
1031 * timestamp: timestamp of the node
1032 * date_rel: relative date of the note (eg. "1 hour ago")
1033 * msg: note message in bbcode
1034 * msg_html: note message in html
1035 * msg_plain: note message in plain text
1036 * link: link to note
1037 * seen: seen state: 0 or 1
1038
1039 ---
1040
1041 ### friendica/notifications/seen (POST)
1042
1043 Set note as seen, returns item object if possible
1044
1045 #### Parameters
1046
1047 id: id of the note to set seen
1048
1049 #### Return values
1050
1051 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
1052
1053 If the note is not linked to an item, a success status is returned:
1054
1055 * `success` (json) | `<status>success</status>` (xml)
1056
1057 ---
1058
1059 ### friendica/photo (*; AUTH)
1060
1061 #### Parameters
1062
1063 * photo_id: Resource id of a photo.
1064 * scale: (optional) scale value of the photo
1065
1066 Returns data of a picture with the given resource.
1067 If 'scale' isn't provided, returned data include full url to each scale of the photo.
1068 If 'scale' is set, returned data include image data base64 encoded.
1069
1070 possibile scale value are:
1071
1072 * 0: original or max size by server settings
1073 * 1: image with or height at <= 640
1074 * 2: image with or height at <= 320
1075 * 3: thumbnail 160x160
1076 * 4: Profile image at 300x300
1077 * 5: Profile image at 80x80
1078 * 6: Profile image at 48x48
1079
1080 An image used as profile image has only scale 4-6, other images only 0-3
1081
1082 #### Return values
1083
1084 json:
1085
1086 ```json
1087         {
1088                 "id": "photo id"
1089                 "created": "date(YYYY-MM-DD HH:MM:SS)",
1090                 "edited": "date(YYYY-MM-DD HH:MM:SS)",
1091                 "title": "photo title",
1092                 "desc": "photo description",
1093                 "album": "album name",
1094                 "filename": "original file name",
1095                 "type": "mime type",
1096                 "height": "number",
1097                 "width": "number",
1098                 "profile": "1 if is profile photo",
1099                 "link": {
1100                         "<scale>": "url to image"
1101                         ...
1102                 },
1103                 // if 'scale' is set
1104                 "datasize": "size in byte",
1105                 "data": "base64 encoded image data"
1106         }
1107 ```
1108
1109 xml:
1110
1111 ```xml
1112         <photo>
1113                 <id>photo id</id>
1114                 <created>date(YYYY-MM-DD HH:MM:SS)</created>
1115                 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
1116                 <title>photo title</title>
1117                 <desc>photo description</desc>
1118                 <album>album name</album>
1119                 <filename>original file name</filename>
1120                 <type>mime type</type>
1121                 <height>number</height>
1122                 <width>number</width>
1123                 <profile>1 if is profile photo</profile>
1124                 <links type="array">
1125                 <link type="mime type" scale="scale number" href="image url"/>
1126                         ...
1127                 </links>
1128         </photo>
1129 ```
1130
1131 ---
1132
1133 ### friendica/photos/list (*; AUTH)
1134
1135 Returns a list of all photo resources of the logged in user.
1136
1137 #### Return values
1138
1139 json:
1140
1141 ```json
1142         [
1143                 {
1144                         id: "resource_id",
1145                         album: "album name",
1146                         filename: "original file name",
1147                         type: "image mime type",
1148                         thumb: "url to thumb sized image"
1149                 },
1150                 ...
1151         ]
1152 ```
1153
1154 xml:
1155
1156 ```xml
1157         <photos type="array">
1158                 <photo id="resource_id"
1159                 album="album name"
1160                 filename="original file name"
1161                 type="image mime type">
1162                         "url to thumb sized image"
1163                 </photo>
1164                 ...
1165         </photos>
1166 ```
1167
1168 ---
1169
1170 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
1171
1172 #### Parameters
1173
1174 * album: name of the album to be deleted
1175
1176 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
1177
1178 #### Return values
1179
1180 On success:
1181
1182 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
1183
1184 On error:
1185
1186 * 403 FORBIDDEN: if not authenticated
1187 * 400 BADREQUEST: "no albumname specified", "album not available"
1188 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1189
1190 ---
1191
1192 ### friendica/photoalbum/update (POST,PUT; AUTH)
1193
1194 #### Parameters
1195
1196 * album: name of the album to be updated
1197 * album_new: new name of the album
1198
1199 changes the album name to album_new for all photos in album
1200
1201 #### Return values
1202
1203 On success:
1204
1205 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1206
1207 On error:
1208
1209 * 403 FORBIDDEN: if not authenticated
1210 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1211 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1212
1213 ---
1214
1215 ### friendica/photo/create (POST; AUTH)
1216
1217 ### friendica/photo/update (POST; AUTH)
1218
1219 #### Parameters
1220
1221 * photo_id (optional): if specified the photo with this id will be updated
1222 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1223 * desc (optional): description for the photo, updated when photo_id is specified
1224 * album: name of the album to be deleted (always necessary)
1225 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1226 * 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;
1227                         on update: keys need to be present with empty values for changing a private photo to public
1228
1229 both calls point to one function for creating AND updating photos.
1230 Saves data for the scales 0-2 to database (see above for scale description).
1231 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1232 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.
1233 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.
1234
1235 #### Return values
1236
1237 On success:
1238
1239 * new photo uploaded: JSON return with photo data (see friendica/photo)
1240 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1241 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1242 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1243
1244 On error:
1245
1246 * 403 FORBIDDEN: if not authenticated
1247 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1248 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1249                         "image size exceeds Friendica Config setting (uploaded size: x)",
1250                         "unable to process image data",
1251                         "image upload failed",
1252                         "unknown error - uploading photo failed, see Friendica log for more information",
1253                         "unknown error - update photo entry in database failed",
1254                         "unknown error - this error on uploading or updating a photo should never happen"
1255
1256 ---
1257
1258 ### friendica/photo/delete (DELETE; AUTH)
1259
1260 #### Parameters
1261
1262 * photo_id: id of the photo to be deleted
1263
1264 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1265 Sets item table entries for this photo to deleted = 1
1266
1267 #### Return values
1268
1269 On success:
1270
1271 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1272
1273 On error:
1274
1275 * 403 FORBIDDEN: if not authenticated
1276 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1277 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1278
1279 ---
1280
1281 ### friendica/direct_messages_setseen (GET; AUTH)
1282
1283 #### Parameters
1284
1285 * id: id of the message to be updated as seen
1286
1287 #### Return values
1288
1289 On success:
1290
1291 * JSON return {"result":"ok","message":"message set to seen"}
1292
1293 On error:
1294
1295 * different JSON returns {"result":"error","message":"xyz"}
1296
1297 ---
1298
1299 ### friendica/direct_messages_search (GET; AUTH)
1300
1301 #### Parameters
1302
1303 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1304
1305 #### Return values
1306
1307 Returns only tested with JSON, XML might work as well.
1308
1309 On success:
1310
1311 * JSON return {"success":"true","search_results": array of found messages}
1312 * JSOn return {"success":"false","search_results":"nothing found"}
1313
1314 On error:
1315
1316 * different JSON returns {"result":"error","message":"searchstring not specified"}
1317
1318 ---
1319
1320 ### friendica/profile/show (GET; AUTH)
1321
1322 show data of all profiles or a single profile of the authenticated user
1323
1324 #### Parameters
1325
1326 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1327
1328 #### Return values
1329
1330 On success: Array of:
1331
1332 * multi_profiles: true if user has activated multi_profiles
1333 * global_dir: URL of the global directory set in server settings
1334 * friendica_owner: user data of the authenticated user
1335 * profiles: array of the profile data
1336
1337 On error:
1338 HTTP 403 Forbidden: when no authentication was provided
1339 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1340
1341 General description of profile data in API returns:
1342
1343 * profile_id
1344 * profile_name
1345 * is_default: true if this is the public profile
1346 * hide_friends: true if friends are hidden
1347 * profile_photo
1348 * profile_thumb
1349 * publish: true if published on the server's local directory
1350 * net_publish: true if published to global_dir
1351 * description ... homepage: different data fields from 'profile' table in database
1352 * users: array with the users allowed to view this profile (empty if is_default=true)
1353
1354 ---
1355
1356 ## Not Implemented API calls
1357
1358 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1359
1360 * statuses/retweets_of_me
1361 * friendships/create
1362 * friendships/destroy
1363 * friendships/exists
1364 * friendships/show
1365 * account/update_profile_background_image
1366 * blocks/create
1367 * blocks/destroy
1368
1369 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1370
1371 * statuses/mentions_timeline
1372 * statuses/retweets/:id
1373 * statuses/oembed
1374 * statuses/retweeters/ids
1375 * statuses/lookup
1376 * direct_messages/show
1377 * friendships/no_retweets/ids
1378 * friendships/outgoing
1379 * friendships/update
1380 * friends/list
1381 * friendships/lookup
1382 * account/settings
1383 * account/update_delivery_device
1384 * blocks/ids
1385 * users/show
1386 * users/search
1387 * account/remove_profile_banner
1388 * account/update_profile_banner
1389 * users/profile_banner
1390 * mutes/users/create
1391 * mutes/users/destroy
1392 * mutes/users/ids
1393 * mutes/users/list
1394 * users/suggestions/:slug
1395 * users/suggestions
1396 * users/suggestions/:slug/members
1397 * favorites/list
1398 * lists/list
1399 * lists/members/destroy
1400 * lists/memberships
1401 * lists/subscribers
1402 * lists/subscribers/create
1403 * lists/subscribers/show
1404 * lists/subscribers/destroy
1405 * lists/members/create_all
1406 * lists/members/show
1407 * lists/members
1408 * lists/members/create
1409 * lists/show
1410 * lists/subscriptions
1411 * lists/members/destroy_all
1412 * saved_searches/show/:id
1413 * saved_searches/create
1414 * saved_searches/destroy/:id
1415 * geo/id/:place_id
1416 * geo/reverse_geocode
1417 * geo/search
1418 * geo/place
1419 * trends/place
1420 * trends/available
1421 * help/configuration
1422 * help/languages
1423 * help/privacy
1424 * help/tos
1425 * trends/closest
1426 * users/report_spam
1427
1428 ---
1429
1430 ---
1431
1432 ## Usage Examples
1433
1434 ### BASH / cURL
1435
1436 ```bash
1437 /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"
1438 ```
1439
1440 ### Python
1441
1442 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1443 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1444
1445 def tweet(server, message, group_allow=None):
1446 url = server + '/api/statuses/update'
1447 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1448
1449 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.