friendica-github/doc/API-Twitter.md

Twitter API

• Home
  • Using the APIs

Overview

Friendica provides the following endpoints defined in the official Twitter API reference.

Authentication is the same as described in Using the APIs.

Entities

These endpoints use the Friendica API entities.

Different behaviour

• 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.
• include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.

Friendica-specific return values

• cid: Contact id of the user (important for "contact_allow" and "contact_deny")
• network: network of the user

Unsupported parameters

• cursor
• trim_user
• contributor_details
• place_id
• display_coordinates
• include_rts: To-Do
• include_my_retweet: Retweets in Friendica are implemented in a different way

Implemented endpoints

• POST api/oauth/access_token

  • Unsupported parameters:
    • x_auth_password
    • x_auth_username
    • x_auth_mode

• POST api/oauth/request_token

  • Unsupported parameter:
    • x_auth_access_type

• GET api/account/verify_credentials

  • Unsupported parameter:
    • include_email

• POST api/account/update_profile

  • Unsupported parameters:
    • url
    • location
    • profile_link_color
    • include_entities
    • skip_status

• POST api/account/update_profile_image

  • Additional parameter:
    • profile_id (optional): Numerical id of the profile for which the image should be used, default is changing the default profile.

• POST api/statuses/update

  • Unsupported parameter:
    • display_coordinates

• POST api/statuses/update_with_media (deprecated)

• POST api/media/upload

  • Additional return value:
    • image.friendica_preview_url: image preview url

• POST api/media/metadata/create

• GET api/users/show

• GET api/users/search

  • Unsupported parameters:
    • page
    • count
    • include_entities

• GET api/users/lookup

  • Unsupported parameters:
    • screen_name
    • include_entities

• GET api/search/tweets

  • Unsupported parameters:
    • geocode
    • lang
    • locale
    • result_type
    • until
    • include_entities

• GET api/saved_searches/list

• GET api/statuses/home_timeline

  • Alias: GET api/statuses/friends_timeline

• GET api/statuses/user_timeline

• GET api/statuses/mentions (deprecated)

• GET api/statuses/show/:id

• POST api/statuses/retweet/:id

• POST api/statuses/destroy/:id

• GET api/statuses/followers (deprecated)

  • Alias: GET api/statuses/friends

• GET api/favorites (deprecated)

  • Unsupported parameters:
    • user_id: Favorites aren't returned for other users than self
    • screen_name: Favorites aren't returned for other users than self

• POST api/favorites/create

• POST api/favorites/destroy

• GET api/lists/list

• GET api/lists/ownerships

  • Unsupported parameters:
    • slug
    • owner_screen_name
    • owner_id
    • include_entities

• GET api/lists/statuses

  • Unsupported parameters:
    • screen_name
    • count

• GET api/lists/subscriptions

• POST api/lists/update

  • Unsupported parameters:
    • slug
    • name
    • mode
    • description
    • owner_screen_name
    • owner_id

• POST api/lists/create

  • Unsupported parameters:
    • mode
    • description

• POST api/lists/destroy

  • Unsupported parameters:
    • owner_screen_name
    • owner_id
    • slug

• GET api/blocks/list

• GET api/friendships/incoming

  • Unsupported parameters
    • stringify_ids
• • GET api/followers/ids
  • GET api/followers/list
  • GET api/friends/ids
  • GET api/friends/list
    • Additional parameters:
      • since_id: You can use the next_cursor value to load the next page.
      • max_id: You can use the inverse of the previous_cursor value to load the previous page.
    • Unsupported parameter:
      • skip_status: No status is returned even if it isn't set to true.
    • Caveats:
      • cursor trumps since_id trumps max_id if any combination is provided.
      • user_id must be the ID of a contact associated with a local user account.
      • screen_name must be associated with a local user account.
      • screen_name trumps user_id if both are provided (undocumented Twitter behavior).
      • Will succeed but return an empty array for users hiding their contact lists.

• POST api/friendships/destroy

Non-implemented endpoints

• GET oauth/authenticate

• GET oauth/authorize

• POST oauth/invalidate_token

• POST oauth2/invalidate_token

• POST oauth2/token

• GET lists/members

• GET lists/members/show

• GET lists/memberships

• GET lists/show

• GET lists/subscribers

• GET lists/subscribers/show

• POST lists/members/create

• POST lists/members/create_all

• POST lists/members/destroy

• POST lists/members/destroy_all

• POST lists/subscribers/create

• POST lists/subscribers/destroy

• GET friendships/lookup

• GET friendships/no_retweets/ids

• GET friendships/outgoing

• GET friendships/show

• GET users/suggestions (deprecated)

• GET users/suggestions/:slug (deprecated)

• GET users/suggestions/:slug/members (deprecated)

• POST friendships/create

• POST friendships/update

• GET account/settings

• GET saved_searches/show/:id

• GET users/profile_banner

• POST account/remove_profile_banner

• POST account/settings

• POST account/update_profile_background_image (deprecated)

• POST account/update_profile_banner

• POST saved_searches/create

• POST saved_searches/destroy/:id

• GET blocks/ids

• GET mutes/users/ids

• GET mutes/users/list

• POST blocks/create

• POST blocks/destroy

• POST mutes/users/create

• POST mutes/users/destroy

• POST users/report_spam

• GET collections/entries

• GET collections/list

• GET collections/show

• POST collections/create

• POST collections/destroy

• POST collections/entries/add

• POST collections/entries/curate

• POST collections/entries/move

• POST collections/entries/remove

• POST collections/update

• POST statuses/filter

• GET statuses/mentions_timeline

• GET favorites/list

• GET statuses/lookup

• GET statuses/oembed

• GET statuses/retweeters/ids

• GET statuses/retweets/:id

• GET statuses/retweets_of_me

• POST statuses/unretweet/:id

• GET statuses/sample

• GET compliance/firehose

• DELETE custom_profiles/destroy.json

• GET custom_profiles/:id

• GET custom_profiles/list

• POST custom_profiles/new.json

• DELETE direct_messages/events/destroy

• GET direct_messages/events/list

• GET direct_messages/events/show

• POST direct_messages/events/new (message_create)

• POST direct_messages/indicate_typing

• POST direct_messages/mark_read

• DELETE direct_messages/welcome_messages/destroy

• DELETE direct_messages/welcome_messages/rules/destroy

• PUT direct_messages/welcome_messages/update

• GET direct_messages/welcome_messages/list

• GET direct_messages/welcome_messages/rules/list

• GET direct_messages/welcome_messages/rules/show

• GET direct_messages/welcome_messages/show

• POST direct_messages/welcome_messages/new

• POST direct_messages/welcome_messages/rules/new

• GET media/upload (STATUS)

• POST media/subtitles/create

• POST media/subtitles/delete

• POST media/upload (APPEND)

• POST media/upload (FINALIZE)

• POST media/upload (INIT)

• GET trends/available

• GET trends/closest

• GET trends/place

• GET geo/id/:place_id

• GET geo/reverse_geocode

• GET geo/search