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 - comments: comment numbers
 661
 662 This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses
 663
 664 JSON:
 665
 666 ```json
 667 [
 668         {
 669                 // ...
 670                 'friendica_owner' : {
 671                         // user object
 672                 },
 673                 'friendica_private' : true,
 674                 'friendica_activities': {
 675                         'like': [
 676                                 {
 677                                         // user object
 678                                 },
 679                                 // ...
 680                         ],
 681                         'dislike': [],
 682                         'attendyes': [],
 683                         'attendno': [],
 684                         'attendmaybe': []
 685                 },
 686                 'friendica_comments': 12
 687         },
 688         // ...
 689 ]
 690 ```
 691
 692 XML:
 693
 694 ```xml
 695 <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">
 696   <status>
 697         <!-- ... -->
 698         <friendica:owner><!-- user object --></friendica:owner>
 699         <friendica:private>true</friendica:private>
 700         <friendica:activities>
 701                 <friendica:like>
 702                 <user>
 703                         <!-- user object -->
 704                 </user>
 705                 <!-- ... --->
 706                 </friendica:like>
 707                 <friendica:dislike/>
 708                 <friendica:attendyes/>
 709                 <friendica:attendno/>
 710                 <friendica:attendmaybe/>
 711         </friendica:activities>
 712         <friendica:comments>21</friendica:comments>
 713         </status>
 714         <!-- ... -->
 715 </statuses>
 716 ```
 717
 718
 719 ---
 720
 721 ### statusnet/config (*)
 722
 723 ---
 724
 725 ### statusnet/conversation (*; AUTH)
 726
 727 It shows all direct answers (excluding the original post) to a given id.
 728
 729 #### Parameter
 730
 731 * id: id of the post
 732 * count: Items per page (default: 20)
 733 * page: page number
 734 * since_id: minimum id
 735 * max_id: maximum id
 736 * include_entities: "true" shows entities for pictures and links (Default: false)
 737
 738 ---
 739
 740 ### statusnet/version (*)
 741
 742 #### Unsupported parameters
 743
 744 * user_id
 745 * screen_name
 746 * cursor
 747
 748 Friendica doesn't allow showing followers of other users.
 749
 750 ---
 751
 752 ### search (*; AUTH)
 753
 754 #### Parameters
 755
 756 * q: search query
 757 * page: the page number (starting at 1) to return
 758 * rpp: the number of statuses to return per page
 759 * count: alias for the rpp parameter
 760 * since_id: returns statuses with ids greater than the given id
 761 * max_id: returns statuses with ids lower or equal to the given id
 762 * exclude_replies: don't show replies (default: false)
 763
 764 #### Unsupported parameters
 765
 766 * geocode
 767 * lang
 768 * locale
 769 * result_type
 770 * until
 771 * include_entities
 772
 773 ---
 774
 775 ### search/tweets (*; AUTH)
 776
 777 This is an alias for `search`.
 778
 779 ---
 780
 781 ### saved_searches/list (*; AUTH)
 782
 783 This call does not have any parameter.
 784
 785 ---
 786
 787 ### users/search (*)
 788
 789 #### Parameters
 790
 791 * q: name of the user
 792
 793 #### Unsupported parameters
 794
 795 * page
 796 * count
 797 * include_entities
 798
 799 ---
 800
 801 ### users/show (*)
 802
 803 #### Parameters
 804
 805 * user_id: id of the user
 806 * screen_name: screen name (for technical reasons, this value is not unique!)
 807 * include_entities: "true" shows entities for pictures and links (Default: false)
 808
 809 #### Unsupported parameters
 810
 811 * user_id
 812 * screen_name
 813 * cursor
 814
 815 Friendica doesn't allow showing friends of other users.
 816
 817 ---
 818
 819 ### users/lookup (*; AUTH)
 820
 821 #### Parameters
 822
 823 * user_id: list of ids to lookup
 824
 825 #### Unsupported parameters
 826
 827 * screen_name
 828 * include_entities
 829
 830 ---
 831
 832 ### account/update_profile_image (POST; AUTH)
 833
 834 #### Parameters
 835
 836 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
 837 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
 838
 839 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
 840
 841 #### Return values
 842
 843 On success:
 844
 845 * JSON return: returns the updated user details (see account/verify_credentials)
 846
 847 On error:
 848
 849 * 403 FORBIDDEN: if not authenticated
 850 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
 851 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
 852                         "image size exceeds Friendica Config setting (uploaded size: x)",
 853                         "unable to process image data",
 854                         "image upload failed"
 855
 856 ---
 857
 858 ### account/update_profile (POST; AUTH)
 859
 860 #### Parameters
 861
 862 * name (optional): full name of the user
 863 * description (optional): a description of the user
 864
 865 #### Unsupported parameters
 866
 867 * url
 868 * location
 869 * profile_link_color
 870 * include_entities
 871 * skip_status
 872
 873 ---
 874
 875 ### friendships/incoming (*; AUTH)
 876
 877 #### Unsupported parameters
 878
 879 * cursor
 880 * stringify_ids
 881
 882 ## Implemented API calls (not compatible with other APIs)
 883
 884 ---
 885
 886 ### friendica/activity/[verb]
 887
 888 #### parameters
 889
 890 * id: item id
 891
 892 Add or remove an activity from an item.
 893 'verb' can be one of:
 894
 895 * like
 896 * dislike
 897 * attendyes
 898 * attendno
 899 * attendmaybe
 900
 901 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
 902 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
 903 Attend verbs should be used only with event-related items (there is no check at the moment)
 904
 905 #### Return values
 906
 907 On success:
 908 json:
 909
 910 ```"ok"```
 911
 912 xml:
 913
 914 ```<ok>true</ok>```
 915
 916 On error:
 917 HTTP 400 BadRequest
 918
 919 ---
 920
 921 ### friendica/group_show (*; AUTH)
 922
 923 Return all or a specified group of the user with the containing contacts as array.
 924
 925 #### Parameters
 926
 927 * gid: optional, if not given, API returns all groups of the user
 928
 929 #### Return values
 930
 931 Array of:
 932
 933 * name: name of the group
 934 * gid: id of the group
 935 * user: array of group members (return from api_get_user() function for each member)
 936
 937 ---
 938
 939 ### friendica/group_delete (POST,DELETE; AUTH)
 940
 941 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
 942
 943 #### Parameters
 944
 945 * gid: id of the group to be deleted
 946 * name: name of the group to be deleted
 947
 948 #### Return values
 949
 950 Array of:
 951
 952 * success: true if successfully deleted
 953 * gid: gid of the deleted group
 954 * name: name of the deleted group
 955 * status: „deleted“ if successfully deleted
 956 * wrong users: empty array
 957
 958 ---
 959
 960 ### friendica/group_create (POST,PUT; AUTH)
 961
 962 Create the group with the posted array of contacts as members.
 963
 964 #### Parameters
 965
 966 * name: name of the group to be created
 967
 968 #### POST data
 969
 970 JSON data as Array like the result of "users/group_show":
 971
 972 * gid
 973 * name
 974 * array of users
 975
 976 #### Return values
 977
 978 Array of:
 979
 980 * success: true if successfully created or reactivated
 981 * gid: gid of the created group
 982 * name: name of the created group
 983 * status: „missing user“ | „reactivated“ | „ok“
 984 * wrong users: array of users, which were not available in the contact table
 985
 986 ---
 987
 988 ### friendica/group_update (POST)
 989
 990 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).
 991
 992 #### Parameters
 993
 994 * gid: id of the group to be changed
 995 * name: name of the group to be changed
 996
 997 #### POST data
 998
 999 JSON data as array like the result of „users/group_show“:
1000
1001 * gid
1002 * name
1003 * array of users
1004
1005 #### Return values
1006
1007 Array of:
1008
1009 * success: true if successfully updated
1010 * gid: gid of the changed group
1011 * name: name of the changed group
1012 * status: „missing user“ | „ok“
1013 * wrong users: array of users, which were not available in the contact table
1014
1015 ---
1016
1017 ### friendica/notifications (GET)
1018
1019 Return last 50 notification for current user, ordered by date with unseen item on top
1020
1021 #### Parameters
1022
1023 none
1024
1025 #### Return values
1026
1027 Array of:
1028
1029 * id: id of the note
1030 * type: type of notification as int (see NOTIFY_* constants in boot.php)
1031 * name: full name of the contact subject of the note
1032 * url: contact's profile url
1033 * photo: contact's profile photo
1034 * date: datetime string of the note
1035 * timestamp: timestamp of the node
1036 * date_rel: relative date of the note (eg. "1 hour ago")
1037 * msg: note message in bbcode
1038 * msg_html: note message in html
1039 * msg_plain: note message in plain text
1040 * link: link to note
1041 * seen: seen state: 0 or 1
1042
1043 ---
1044
1045 ### friendica/notifications/seen (POST)
1046
1047 Set note as seen, returns item object if possible
1048
1049 #### Parameters
1050
1051 id: id of the note to set seen
1052
1053 #### Return values
1054
1055 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
1056
1057 If the note is not linked to an item, a success status is returned:
1058
1059 * `success` (json) | `<status>success</status>` (xml)
1060
1061 ---
1062
1063 ### friendica/photo (*; AUTH)
1064
1065 #### Parameters
1066
1067 * photo_id: Resource id of a photo.
1068 * scale: (optional) scale value of the photo
1069
1070 Returns data of a picture with the given resource.
1071 If 'scale' isn't provided, returned data include full url to each scale of the photo.
1072 If 'scale' is set, returned data include image data base64 encoded.
1073
1074 possibile scale value are:
1075
1076 * 0: original or max size by server settings
1077 * 1: image with or height at <= 640
1078 * 2: image with or height at <= 320
1079 * 3: thumbnail 160x160
1080 * 4: Profile image at 300x300
1081 * 5: Profile image at 80x80
1082 * 6: Profile image at 48x48
1083
1084 An image used as profile image has only scale 4-6, other images only 0-3
1085
1086 #### Return values
1087
1088 json:
1089
1090 ```json
1091         {
1092                 "id": "photo id"
1093                 "created": "date(YYYY-MM-DD HH:MM:SS)",
1094                 "edited": "date(YYYY-MM-DD HH:MM:SS)",
1095                 "title": "photo title",
1096                 "desc": "photo description",
1097                 "album": "album name",
1098                 "filename": "original file name",
1099                 "type": "mime type",
1100                 "height": "number",
1101                 "width": "number",
1102                 "profile": "1 if is profile photo",
1103                 "link": {
1104                         "<scale>": "url to image"
1105                         ...
1106                 },
1107                 // if 'scale' is set
1108                 "datasize": "size in byte",
1109                 "data": "base64 encoded image data"
1110         }
1111 ```
1112
1113 xml:
1114
1115 ```xml
1116         <photo>
1117                 <id>photo id</id>
1118                 <created>date(YYYY-MM-DD HH:MM:SS)</created>
1119                 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
1120                 <title>photo title</title>
1121                 <desc>photo description</desc>
1122                 <album>album name</album>
1123                 <filename>original file name</filename>
1124                 <type>mime type</type>
1125                 <height>number</height>
1126                 <width>number</width>
1127                 <profile>1 if is profile photo</profile>
1128                 <links type="array">
1129                 <link type="mime type" scale="scale number" href="image url"/>
1130                         ...
1131                 </links>
1132         </photo>
1133 ```
1134
1135 ---
1136
1137 ### friendica/photos/list (*; AUTH)
1138
1139 Returns a list of all photo resources of the logged in user.
1140
1141 #### Return values
1142
1143 json:
1144
1145 ```json
1146         [
1147                 {
1148                         id: "resource_id",
1149                         album: "album name",
1150                         filename: "original file name",
1151                         type: "image mime type",
1152                         thumb: "url to thumb sized image"
1153                 },
1154                 ...
1155         ]
1156 ```
1157
1158 xml:
1159
1160 ```xml
1161         <photos type="array">
1162                 <photo id="resource_id"
1163                 album="album name"
1164                 filename="original file name"
1165                 type="image mime type">
1166                         "url to thumb sized image"
1167                 </photo>
1168                 ...
1169         </photos>
1170 ```
1171
1172 ---
1173
1174 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
1175
1176 #### Parameters
1177
1178 * album: name of the album to be deleted
1179
1180 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
1181
1182 #### Return values
1183
1184 On success:
1185
1186 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
1187
1188 On error:
1189
1190 * 403 FORBIDDEN: if not authenticated
1191 * 400 BADREQUEST: "no albumname specified", "album not available"
1192 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1193
1194 ---
1195
1196 ### friendica/photoalbum/update (POST,PUT; AUTH)
1197
1198 #### Parameters
1199
1200 * album: name of the album to be updated
1201 * album_new: new name of the album
1202
1203 changes the album name to album_new for all photos in album
1204
1205 #### Return values
1206
1207 On success:
1208
1209 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1210
1211 On error:
1212
1213 * 403 FORBIDDEN: if not authenticated
1214 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1215 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1216
1217 ---
1218
1219 ### friendica/photo/create (POST; AUTH)
1220
1221 ### friendica/photo/update (POST; AUTH)
1222
1223 #### Parameters
1224
1225 * photo_id (optional): if specified the photo with this id will be updated
1226 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1227 * desc (optional): description for the photo, updated when photo_id is specified
1228 * album: name of the album to be deleted (always necessary)
1229 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1230 * 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;
1231                         on update: keys need to be present with empty values for changing a private photo to public
1232
1233 both calls point to one function for creating AND updating photos.
1234 Saves data for the scales 0-2 to database (see above for scale description).
1235 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1236 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.
1237 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.
1238
1239 #### Return values
1240
1241 On success:
1242
1243 * new photo uploaded: JSON return with photo data (see friendica/photo)
1244 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1245 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1246 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1247
1248 On error:
1249
1250 * 403 FORBIDDEN: if not authenticated
1251 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1252 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1253                         "image size exceeds Friendica Config setting (uploaded size: x)",
1254                         "unable to process image data",
1255                         "image upload failed",
1256                         "unknown error - uploading photo failed, see Friendica log for more information",
1257                         "unknown error - update photo entry in database failed",
1258                         "unknown error - this error on uploading or updating a photo should never happen"
1259
1260 ---
1261
1262 ### friendica/photo/delete (DELETE; AUTH)
1263
1264 #### Parameters
1265
1266 * photo_id: id of the photo to be deleted
1267
1268 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1269 Sets item table entries for this photo to deleted = 1
1270
1271 #### Return values
1272
1273 On success:
1274
1275 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1276
1277 On error:
1278
1279 * 403 FORBIDDEN: if not authenticated
1280 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1281 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1282
1283 ---
1284
1285 ### friendica/direct_messages_setseen (GET; AUTH)
1286
1287 #### Parameters
1288
1289 * id: id of the message to be updated as seen
1290
1291 #### Return values
1292
1293 On success:
1294
1295 * JSON return {"result":"ok","message":"message set to seen"}
1296
1297 On error:
1298
1299 * different JSON returns {"result":"error","message":"xyz"}
1300
1301 ---
1302
1303 ### friendica/direct_messages_search (GET; AUTH)
1304
1305 #### Parameters
1306
1307 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1308
1309 #### Return values
1310
1311 Returns only tested with JSON, XML might work as well.
1312
1313 On success:
1314
1315 * JSON return {"success":"true","search_results": array of found messages}
1316 * JSOn return {"success":"false","search_results":"nothing found"}
1317
1318 On error:
1319
1320 * different JSON returns {"result":"error","message":"searchstring not specified"}
1321
1322 ---
1323
1324 ### friendica/profile/show (GET; AUTH)
1325
1326 show data of all profiles or a single profile of the authenticated user
1327
1328 #### Parameters
1329
1330 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1331
1332 #### Return values
1333
1334 On success: Array of:
1335
1336 * multi_profiles: true if user has activated multi_profiles
1337 * global_dir: URL of the global directory set in server settings
1338 * friendica_owner: user data of the authenticated user
1339 * profiles: array of the profile data
1340
1341 On error:
1342 HTTP 403 Forbidden: when no authentication was provided
1343 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1344
1345 General description of profile data in API returns:
1346
1347 * profile_id
1348 * profile_name
1349 * is_default: true if this is the public profile
1350 * hide_friends: true if friends are hidden
1351 * profile_photo
1352 * profile_thumb
1353 * publish: true if published on the server's local directory
1354 * net_publish: true if published to global_dir
1355 * description ... homepage: different data fields from 'profile' table in database
1356 * users: array with the users allowed to view this profile (empty if is_default=true)
1357
1358 ---
1359
1360 ## Not Implemented API calls
1361
1362 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1363
1364 * statuses/retweets_of_me
1365 * friendships/create
1366 * friendships/destroy
1367 * friendships/exists
1368 * friendships/show
1369 * account/update_profile_background_image
1370 * blocks/create
1371 * blocks/destroy
1372
1373 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1374
1375 * statuses/mentions_timeline
1376 * statuses/retweets/:id
1377 * statuses/oembed
1378 * statuses/retweeters/ids
1379 * statuses/lookup
1380 * direct_messages/show
1381 * friendships/no_retweets/ids
1382 * friendships/outgoing
1383 * friendships/update
1384 * friends/list
1385 * friendships/lookup
1386 * account/settings
1387 * account/update_delivery_device
1388 * blocks/ids
1389 * users/show
1390 * users/search
1391 * account/remove_profile_banner
1392 * account/update_profile_banner
1393 * users/profile_banner
1394 * mutes/users/create
1395 * mutes/users/destroy
1396 * mutes/users/ids
1397 * mutes/users/list
1398 * users/suggestions/:slug
1399 * users/suggestions
1400 * users/suggestions/:slug/members
1401 * favorites/list
1402 * lists/list
1403 * lists/members/destroy
1404 * lists/memberships
1405 * lists/subscribers
1406 * lists/subscribers/create
1407 * lists/subscribers/show
1408 * lists/subscribers/destroy
1409 * lists/members/create_all
1410 * lists/members/show
1411 * lists/members
1412 * lists/members/create
1413 * lists/show
1414 * lists/subscriptions
1415 * lists/members/destroy_all
1416 * saved_searches/show/:id
1417 * saved_searches/create
1418 * saved_searches/destroy/:id
1419 * geo/id/:place_id
1420 * geo/reverse_geocode
1421 * geo/search
1422 * geo/place
1423 * trends/place
1424 * trends/available
1425 * help/configuration
1426 * help/languages
1427 * help/privacy
1428 * help/tos
1429 * trends/closest
1430 * users/report_spam
1431
1432 ---
1433
1434 ---
1435
1436 ## Usage Examples
1437
1438 ### BASH / cURL
1439
1440 ```bash
1441 /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"
1442 ```
1443
1444 ### Python
1445
1446 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1447 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1448
1449 def tweet(server, message, group_allow=None):
1450 url = server + '/api/statuses/update'
1451 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1452
1453 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.