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 ### media/upload (POST,PUT; AUTH)
 298
 299 #### Parameters
 300
 301 * media: image data
 302
 303 ---
 304
 305 ### oauth/request_token (*)
 306
 307 #### Parameters
 308
 309 * oauth_callback
 310
 311 #### Unsupported parameters
 312
 313 * x_auth_access_type
 314
 315 ---
 316
 317 ### oauth/access_token (*)
 318
 319 #### Parameters
 320
 321 * oauth_verifier
 322
 323 #### Unsupported parameters
 324
 325 * x_auth_password
 326 * x_auth_username
 327 * x_auth_mode
 328
 329 ---
 330
 331 ### statuses/destroy (POST,DELETE; AUTH)
 332
 333 #### Parameters
 334
 335 * id: message number
 336 * include_entities: "true" shows entities for pictures and links (Default: false)
 337
 338 #### Unsupported parameters
 339
 340 * trim_user
 341
 342 ---
 343
 344 ### statuses/followers (*; AUTH)
 345
 346 #### Parameters
 347
 348 * include_entities: "true" shows entities for pictures and links (Default: false)
 349
 350 ---
 351
 352 ### statuses/friends (*; AUTH)
 353
 354 #### Parameters
 355
 356 * include_entities: "true" shows entities for pictures and links (Default: false)
 357
 358 ---
 359
 360 ### blocks/list (*; AUTH)
 361
 362 #### Parameters
 363
 364 * include_entities: "true" shows entities for pictures and links (Default: false)
 365 * count: Items per page (default: 20).
 366 * page: page number
 367
 368 #### Unsupported parameters
 369
 370 * cursor
 371 * skip_status
 372
 373 ---
 374
 375 ### statuses/friends_timeline (*; AUTH)
 376
 377 #### Parameters
 378
 379 * count: Items per page (default: 20)
 380 * page: page number
 381 * since_id: minimum id
 382 * max_id: maximum id
 383 * exclude_replies: don't show replies (default: false)
 384 * conversation_id: Shows all statuses of a given conversation.
 385 * include_entities: "true" shows entities for pictures and links (Default: false)
 386
 387 #### Unsupported parameters
 388
 389 * include_rts
 390 * trim_user
 391 * contributor_details
 392
 393 ---
 394
 395 ### statuses/home_timeline (*; AUTH)
 396
 397 #### Parameters
 398
 399 * count: Items per page (default: 20)
 400 * page: page number
 401 * since_id: minimum id
 402 * max_id: maximum id
 403 * exclude_replies: don't show replies (default: false)
 404 * conversation_id: Shows all statuses of a given conversation.
 405 * include_entities: "true" shows entities for pictures and links (Default: false)
 406
 407 #### Unsupported parameters
 408
 409 * include_rts
 410 * trim_user
 411 * contributor_details
 412
 413 ---
 414
 415 ### statuses/mentions (*; AUTH)
 416
 417 #### Parameters
 418
 419 * count: Items per page (default: 20)
 420 * page: page number
 421 * since_id: minimum id
 422 * max_id: maximum id
 423 * include_entities: "true" shows entities for pictures and links (Default: false)
 424
 425 #### Unsupported parameters
 426
 427 * include_rts
 428 * trim_user
 429 * contributor_details
 430
 431 ---
 432
 433 ### statuses/public_timeline (*; AUTH)
 434
 435 #### Parameters
 436
 437 * count: Items per page (default: 20)
 438 * page: page number
 439 * since_id: minimum id
 440 * max_id: maximum id
 441 * exclude_replies: don't show replies (default: false)
 442 * conversation_id: Shows all statuses of a given conversation.
 443 * include_entities: "true" shows entities for pictures and links (Default: false)
 444
 445 #### Unsupported parameters
 446
 447 * trim_user
 448
 449 ---
 450
 451 ### statuses/networkpublic_timeline (*; AUTH)
 452
 453 #### Parameters
 454
 455 * count: Items per page (default: 20)
 456 * page: page number
 457 * since_id: minimum id
 458 * max_id: maximum id
 459 * include_entities: "true" shows entities for pictures and links (Default: false)
 460
 461 ---
 462
 463 ### statuses/replies (*; AUTH)
 464
 465 #### Parameters
 466
 467 * count: Items per page (default: 20)
 468 * page: page number
 469 * since_id: minimum id
 470 * max_id: maximum id
 471 * include_entities: "true" shows entities for pictures and links (Default: false)
 472
 473 #### Unsupported parameters
 474
 475 * include_rts
 476 * trim_user
 477 * contributor_details
 478
 479 ---
 480
 481 ### statuses/retweet (POST,PUT; AUTH)
 482
 483 #### Parameters
 484
 485 * id: message number
 486 * include_entities: "true" shows entities for pictures and links (Default: false)
 487
 488 #### Unsupported parameters
 489
 490 * trim_user
 491
 492 ---
 493
 494 ### statuses/show (*; AUTH)
 495
 496 #### Parameters
 497
 498 * id: message number
 499 * conversation: if set to "1" show all messages of the conversation with the given id
 500 * include_entities: "true" shows entities for pictures and links (Default: false)
 501
 502 #### Unsupported parameters
 503
 504 * include_my_retweet
 505 * trim_user
 506
 507 ---
 508
 509 ### statuses/update, statuses/update_with_media
 510
 511 #### Parameters
 512
 513 * title: Title of the status
 514 * status: Status in text format
 515 * htmlstatus: Status in HTML format
 516 * in_reply_to_status_id
 517 * lat: latitude
 518 * long: longitude
 519 * media: image data
 520 * source: Application name
 521 * group_allow
 522 * contact_allow
 523 * group_deny
 524 * contact_deny
 525 * network
 526 * include_entities: "true" shows entities for pictures and links (Default: false)
 527 * media_ids: (By now only a single value, no array)
 528
 529 #### Unsupported parameters
 530
 531 * trim_user
 532 * place_id
 533 * display_coordinates
 534
 535 ---
 536
 537 ### statuses/user_timeline (*; AUTH)
 538
 539 #### Parameters
 540
 541 * user_id: id of the user
 542 * screen_name: screen name (for technical reasons, this value is not unique!)
 543 * count: Items per page (default: 20)
 544 * page: page number
 545 * since_id: minimum id
 546 * max_id: maximum id
 547 * exclude_replies: don't show replies (default: false)
 548 * conversation_id: Shows all statuses of a given conversation.
 549 * include_entities: "true" shows entities for pictures and links (Default: false)
 550
 551 #### Unsupported parameters
 552
 553 * include_rts
 554 * trim_user
 555 * contributor_details
 556
 557 ---
 558
 559 ### statusnet/config (*)
 560
 561 ---
 562
 563 ### statusnet/conversation (*; AUTH)
 564
 565 It shows all direct answers (excluding the original post) to a given id.
 566
 567 #### Parameter
 568
 569 * id: id of the post
 570 * count: Items per page (default: 20)
 571 * page: page number
 572 * since_id: minimum id
 573 * max_id: maximum id
 574 * include_entities: "true" shows entities for pictures and links (Default: false)
 575
 576 ---
 577
 578 ### statusnet/version (*)
 579
 580 #### Unsupported parameters
 581
 582 * user_id
 583 * screen_name
 584 * cursor
 585
 586 Friendica doesn't allow showing followers of other users.
 587
 588 ---
 589
 590 ### search (*; AUTH)
 591
 592 #### Parameters
 593
 594 * q: search query
 595 * page: the page number (starting at 1) to return
 596 * rpp: the number of statuses to return per page
 597 * count: alias for the rpp parameter
 598 * since_id: returns statuses with ids greater than the given id
 599 * max_id: returns statuses with ids lower or equal to the given id
 600
 601 #### Unsupported parameters
 602
 603 * geocode
 604 * lang
 605 * locale
 606 * result_type
 607 * until
 608 * include_entities
 609
 610 ---
 611
 612 ### users/search (*)
 613
 614 #### Parameters
 615
 616 * q: name of the user
 617
 618 #### Unsupported parameters
 619
 620 * page
 621 * count
 622 * include_entities
 623
 624 ---
 625
 626 ### users/show (*)
 627
 628 #### Parameters
 629
 630 * user_id: id of the user
 631 * screen_name: screen name (for technical reasons, this value is not unique!)
 632 * include_entities: "true" shows entities for pictures and links (Default: false)
 633
 634 #### Unsupported parameters
 635
 636 * user_id
 637 * screen_name
 638 * cursor
 639
 640 Friendica doesn't allow showing friends of other users.
 641
 642 ---
 643
 644 ### users/lookup (*; AUTH)
 645
 646 #### Parameters
 647
 648 * user_id: list of ids to lookup
 649
 650 #### Unsupported parameters
 651
 652 * screen_name
 653 * include_entities
 654
 655 ---
 656
 657 ### account/update_profile_image (POST; AUTH)
 658
 659 #### Parameters
 660
 661 * image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
 662 * profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
 663
 664 uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
 665
 666 #### Return values
 667
 668 On success:
 669
 670 * JSON return: returns the updated user details (see account/verify_credentials)
 671
 672 On error:
 673
 674 * 403 FORBIDDEN: if not authenticated
 675 * 400 BADREQUEST: "no media data submitted", "profile_id not available"
 676 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
 677                         "image size exceeds Friendica Config setting (uploaded size: x)",
 678                         "unable to process image data",
 679                         "image upload failed"
 680
 681 ---
 682
 683 ### friendships/incoming (*; AUTH)
 684
 685 #### Unsupported parameters
 686
 687 * cursor
 688 * stringify_ids
 689
 690 ## Implemented API calls (not compatible with other APIs)
 691
 692 ---
 693
 694 ### friendica/activity/[verb]
 695
 696 #### parameters
 697
 698 * id: item id
 699
 700 Add or remove an activity from an item.
 701 'verb' can be one of:
 702
 703 * like
 704 * dislike
 705 * attendyes
 706 * attendno
 707 * attendmaybe
 708
 709 To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
 710 Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
 711 Attend verbs should be used only with event-related items (there is no check at the moment)
 712
 713 #### Return values
 714
 715 On success:
 716 json:
 717
 718 ```"ok"```
 719
 720 xml:
 721
 722 ```<ok>true</ok>```
 723
 724 On error:
 725 HTTP 400 BadRequest
 726
 727 ---
 728
 729 ### friendica/group_show (*; AUTH)
 730
 731 Return all or a specified group of the user with the containing contacts as array.
 732
 733 #### Parameters
 734
 735 * gid: optional, if not given, API returns all groups of the user
 736
 737 #### Return values
 738
 739 Array of:
 740
 741 * name: name of the group
 742 * gid: id of the group
 743 * user: array of group members (return from api_get_user() function for each member)
 744
 745 ---
 746
 747 ### friendica/group_delete (POST,DELETE; AUTH)
 748
 749 delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
 750
 751 #### Parameters
 752
 753 * gid: id of the group to be deleted
 754 * name: name of the group to be deleted
 755
 756 #### Return values
 757
 758 Array of:
 759
 760 * success: true if successfully deleted
 761 * gid: gid of the deleted group
 762 * name: name of the deleted group
 763 * status: „deleted“ if successfully deleted
 764 * wrong users: empty array
 765
 766 ---
 767
 768 ### friendica/group_create (POST,PUT; AUTH)
 769
 770 Create the group with the posted array of contacts as members.
 771
 772 #### Parameters
 773
 774 * name: name of the group to be created
 775
 776 #### POST data
 777
 778 JSON data as Array like the result of "users/group_show":
 779
 780 * gid
 781 * name
 782 * array of users
 783
 784 #### Return values
 785
 786 Array of:
 787
 788 * success: true if successfully created or reactivated
 789 * gid: gid of the created group
 790 * name: name of the created group
 791 * status: „missing user“ | „reactivated“ | „ok“
 792 * wrong users: array of users, which were not available in the contact table
 793
 794 ---
 795
 796 ### friendica/group_update (POST)
 797
 798 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).
 799
 800 #### Parameters
 801
 802 * gid: id of the group to be changed
 803 * name: name of the group to be changed
 804
 805 #### POST data
 806
 807 JSON data as array like the result of „users/group_show“:
 808
 809 * gid
 810 * name
 811 * array of users
 812
 813 #### Return values
 814
 815 Array of:
 816
 817 * success: true if successfully updated
 818 * gid: gid of the changed group
 819 * name: name of the changed group
 820 * status: „missing user“ | „ok“
 821 * wrong users: array of users, which were not available in the contact table
 822
 823 ---
 824
 825 ### friendica/notifications (GET)
 826
 827 Return last 50 notification for current user, ordered by date with unseen item on top
 828
 829 #### Parameters
 830
 831 none
 832
 833 #### Return values
 834
 835 Array of:
 836
 837 * id: id of the note
 838 * type: type of notification as int (see NOTIFY_* constants in boot.php)
 839 * name: full name of the contact subject of the note
 840 * url: contact's profile url
 841 * photo: contact's profile photo
 842 * date: datetime string of the note
 843 * timestamp: timestamp of the node
 844 * date_rel: relative date of the note (eg. "1 hour ago")
 845 * msg: note message in bbcode
 846 * msg_html: note message in html
 847 * msg_plain: note message in plain text
 848 * link: link to note
 849 * seen: seen state: 0 or 1
 850
 851 ---
 852
 853 ### friendica/notifications/seen (POST)
 854
 855 Set note as seen, returns item object if possible
 856
 857 #### Parameters
 858
 859 id: id of the note to set seen
 860
 861 #### Return values
 862
 863 If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
 864
 865 If the note is not linked to an item, a success status is returned:
 866
 867 * `success` (json) | `<status>success</status>` (xml)
 868
 869 ---
 870
 871 ### friendica/photo (*; AUTH)
 872
 873 #### Parameters
 874
 875 * photo_id: Resource id of a photo.
 876 * scale: (optional) scale value of the photo
 877
 878 Returns data of a picture with the given resource.
 879 If 'scale' isn't provided, returned data include full url to each scale of the photo.
 880 If 'scale' is set, returned data include image data base64 encoded.
 881
 882 possibile scale value are:
 883
 884 * 0: original or max size by server settings
 885 * 1: image with or height at <= 640
 886 * 2: image with or height at <= 320
 887 * 3: thumbnail 160x160
 888 * 4: Profile image at 175x175
 889 * 5: Profile image at 80x80
 890 * 6: Profile image at 48x48
 891
 892 An image used as profile image has only scale 4-6, other images only 0-3
 893
 894 #### Return values
 895
 896 json:
 897
 898 ```json
 899         {
 900                 "id": "photo id"
 901                 "created": "date(YYYY-MM-DD HH:MM:SS)",
 902                 "edited": "date(YYYY-MM-DD HH:MM:SS)",
 903                 "title": "photo title",
 904                 "desc": "photo description",
 905                 "album": "album name",
 906                 "filename": "original file name",
 907                 "type": "mime type",
 908                 "height": "number",
 909                 "width": "number",
 910                 "profile": "1 if is profile photo",
 911                 "link": {
 912                         "<scale>": "url to image"
 913                         ...
 914                 },
 915                 // if 'scale' is set
 916                 "datasize": "size in byte",
 917                 "data": "base64 encoded image data"
 918         }
 919 ```
 920
 921 xml:
 922
 923 ```xml
 924         <photo>
 925                 <id>photo id</id>
 926                 <created>date(YYYY-MM-DD HH:MM:SS)</created>
 927                 <edited>date(YYYY-MM-DD HH:MM:SS)</edited>
 928                 <title>photo title</title>
 929                 <desc>photo description</desc>
 930                 <album>album name</album>
 931                 <filename>original file name</filename>
 932                 <type>mime type</type>
 933                 <height>number</height>
 934                 <width>number</width>
 935                 <profile>1 if is profile photo</profile>
 936                 <links type="array">
 937                 <link type="mime type" scale="scale number" href="image url"/>
 938                         ...
 939                 </links>
 940         </photo>
 941 ```
 942
 943 ---
 944
 945 ### friendica/photos/list (*; AUTH)
 946
 947 Returns a list of all photo resources of the logged in user.
 948
 949 #### Return values
 950
 951 json:
 952
 953 ```json
 954         [
 955                 {
 956                         id: "resource_id",
 957                         album: "album name",
 958                         filename: "original file name",
 959                         type: "image mime type",
 960                         thumb: "url to thumb sized image"
 961                 },
 962                 ...
 963         ]
 964 ```
 965
 966 xml:
 967
 968 ```xml
 969         <photos type="array">
 970                 <photo id="resource_id"
 971                 album="album name"
 972                 filename="original file name"
 973                 type="image mime type">
 974                         "url to thumb sized image"
 975                 </photo>
 976                 ...
 977         </photos>
 978 ```
 979
 980 ---
 981
 982 ### friendica/photoalbum/delete (POST,DELETE; AUTH)
 983
 984 #### Parameters
 985
 986 * album: name of the album to be deleted
 987
 988 deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
 989
 990 #### Return values
 991
 992 On success:
 993
 994 * JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
 995
 996 On error:
 997
 998 * 403 FORBIDDEN: if not authenticated
 999 * 400 BADREQUEST: "no albumname specified", "album not available"
1000 * 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
1001
1002 ---
1003
1004 ### friendica/photoalbum/update (POST,PUT; AUTH)
1005
1006 #### Parameters
1007
1008 * album: name of the album to be updated
1009 * album_new: new name of the album
1010
1011 changes the album name to album_new for all photos in album
1012
1013 #### Return values
1014
1015 On success:
1016
1017 * JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
1018
1019 On error:
1020
1021 * 403 FORBIDDEN: if not authenticated
1022 * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
1023 * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
1024
1025 ---
1026
1027 ### friendica/photo/create (POST; AUTH)
1028
1029 ### friendica/photo/update (POST; AUTH)
1030
1031 #### Parameters
1032
1033 * photo_id (optional): if specified the photo with this id will be updated
1034 * media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
1035 * desc (optional): description for the photo, updated when photo_id is specified
1036 * album: name of the album to be deleted (always necessary)
1037 * album_new (optional): can be used to change the album of a single photo if photo_id is specified
1038 * 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;
1039                         on update: keys need to be present with empty values for changing a private photo to public
1040
1041 both calls point to one function for creating AND updating photos.
1042 Saves data for the scales 0-2 to database (see above for scale description).
1043 Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
1044 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.
1045 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.
1046
1047 #### Return values
1048
1049 On success:
1050
1051 * new photo uploaded: JSON return with photo data (see friendica/photo)
1052 * photo updated - changed photo data: JSON return with photo data (see friendica/photo)
1053 * photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
1054 * photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
1055
1056 On error:
1057
1058 * 403 FORBIDDEN: if not authenticated
1059 * 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
1060 * 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
1061                         "image size exceeds Friendica Config setting (uploaded size: x)",
1062                         "unable to process image data",
1063                         "image upload failed",
1064                         "unknown error - uploading photo failed, see Friendica log for more information",
1065                         "unknown error - update photo entry in database failed",
1066                         "unknown error - this error on uploading or updating a photo should never happen"
1067
1068 ---
1069
1070 ### friendica/photo/delete (DELETE; AUTH)
1071
1072 #### Parameters
1073
1074 * photo_id: id of the photo to be deleted
1075
1076 deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
1077 Sets item table entries for this photo to deleted = 1
1078
1079 #### Return values
1080
1081 On success:
1082
1083 * JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
1084
1085 On error:
1086
1087 * 403 FORBIDDEN: if not authenticated
1088 * 400 BADREQUEST: "no photo_id specified", "photo not available"
1089 * 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
1090
1091 ---
1092
1093 ### friendica/direct_messages_setseen (GET; AUTH)
1094
1095 #### Parameters
1096
1097 * id: id of the message to be updated as seen
1098
1099 #### Return values
1100
1101 On success:
1102
1103 * JSON return {"result":"ok","message":"message set to seen"}
1104
1105 On error:
1106
1107 * different JSON returns {"result":"error","message":"xyz"}
1108
1109 ---
1110
1111 ### friendica/direct_messages_search (GET; AUTH)
1112
1113 #### Parameters
1114
1115 * searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
1116
1117 #### Return values
1118
1119 Returns only tested with JSON, XML might work as well.
1120
1121 On success:
1122
1123 * JSON return {"success":"true","search_results": array of found messages}
1124 * JSOn return {"success":"false","search_results":"nothing found"}
1125
1126 On error:
1127
1128 * different JSON returns {"result":"error","message":"searchstring not specified"}
1129
1130 ---
1131
1132 ### friendica/profile/show (GET; AUTH)
1133
1134 show data of all profiles or a single profile of the authenticated user
1135
1136 #### Parameters
1137
1138 * profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
1139
1140 #### Return values
1141
1142 On success: Array of:
1143
1144 * multi_profiles: true if user has activated multi_profiles
1145 * global_dir: URL of the global directory set in server settings
1146 * friendica_owner: user data of the authenticated user
1147 * profiles: array of the profile data
1148
1149 On error:
1150 HTTP 403 Forbidden: when no authentication was provided
1151 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
1152
1153 General description of profile data in API returns:
1154
1155 * profile_id
1156 * profile_name
1157 * is_default: true if this is the public profile
1158 * hide_friends: true if friends are hidden
1159 * profile_photo
1160 * profile_thumb
1161 * publish: true if published on the server's local directory
1162 * net_publish: true if published to global_dir
1163 * description ... homepage: different data fields from 'profile' table in database
1164 * users: array with the users allowed to view this profile (empty if is_default=true)
1165
1166 ---
1167
1168 ## Not Implemented API calls
1169
1170 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
1171
1172 * statuses/retweets_of_me
1173 * friendships/create
1174 * friendships/destroy
1175 * friendships/exists
1176 * friendships/show
1177 * account/update_profile_background_image
1178 * blocks/create
1179 * blocks/destroy
1180
1181 The following API calls from the Twitter API are not implemented in either Friendica or GNU Social:
1182
1183 * statuses/mentions_timeline
1184 * statuses/retweets/:id
1185 * statuses/oembed
1186 * statuses/retweeters/ids
1187 * statuses/lookup
1188 * direct_messages/show
1189 * search/tweets
1190 * friendships/no_retweets/ids
1191 * friendships/outgoing
1192 * friendships/update
1193 * friends/list
1194 * friendships/lookup
1195 * account/settings
1196 * account/update_delivery_device
1197 * account/update_profile
1198 * account/update_profile_background_image
1199 * blocks/ids
1200 * users/show
1201 * users/search
1202 * account/remove_profile_banner
1203 * account/update_profile_banner
1204 * users/profile_banner
1205 * mutes/users/create
1206 * mutes/users/destroy
1207 * mutes/users/ids
1208 * mutes/users/list
1209 * users/suggestions/:slug
1210 * users/suggestions
1211 * users/suggestions/:slug/members
1212 * favorites/list
1213 * lists/list
1214 * lists/statuses
1215 * lists/members/destroy
1216 * lists/memberships
1217 * lists/subscribers
1218 * lists/subscribers/create
1219 * lists/subscribers/show
1220 * lists/subscribers/destroy
1221 * lists/members/create_all
1222 * lists/members/show
1223 * lists/members
1224 * lists/members/create
1225 * lists/destroy
1226 * lists/update
1227 * lists/create
1228 * lists/show
1229 * lists/subscriptions
1230 * lists/members/destroy_all
1231 * lists/ownerships
1232 * saved_searches/list
1233 * saved_searches/show/:id
1234 * saved_searches/create
1235 * saved_searches/destroy/:id
1236 * geo/id/:place_id
1237 * geo/reverse_geocode
1238 * geo/search
1239 * geo/place
1240 * trends/place
1241 * trends/available
1242 * help/configuration
1243 * help/languages
1244 * help/privacy
1245 * help/tos
1246 * trends/closest
1247 * users/report_spam
1248
1249 ---
1250
1251 ---
1252
1253 ## Usage Examples
1254
1255 ### BASH / cURL
1256
1257 ```bash
1258 /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"
1259 ```
1260
1261 ### Python
1262
1263 The [RSStoFriendika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python.
1264 The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
1265
1266 def tweet(server, message, group_allow=None):
1267 url = server + '/api/statuses/update'
1268 urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
1269
1270 There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.