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

⇧