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