Twitter API
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 isfalse. If set totruethen the plain text is formatted so that links are having descriptions.
Friendica-specific return values
cid: Contact id of the user (important forcontact_allowandcontact_deny)network: network of the user
Unsupported parameters
cursortrim_usercontributor_detailsplace_iddisplay_coordinatesinclude_rts: To-Doinclude_my_retweet: Retweets in Friendica are implemented in a different way
Implemented endpoints
-
- Unsupported parameters:
x_auth_passwordx_auth_usernamex_auth_mode
-
- Unsupported parameter:
x_auth_access_type
-
- Unsupported parameter:
include_email
-
- Unsupported parameters:
urllocationprofile_link_colorinclude_entitiesskip_status
-
- Additional parameter:
profile_id(optional): Numerical id of the profile for which the image should be used, default is changing the default profile.
-
- Unsupported parameter:
display_coordinates
-
- Additional return value:
image.friendica_preview_url: image preview url
-
- Unsupported parameters:
pagecountinclude_entities
-
- Unsupported parameters:
screen_nameinclude_entities
-
- Unsupported parameters:
geocodelanglocaleresult_typeuntilinclude_entities
-
- Alias:
GET api/statuses/friends_timeline
- Alias:
GET api/statuses/friends
-
- Unsupported parameters:
user_id: Favorites aren’t returned for other users than selfscreen_name: Favorites aren’t returned for other users than self
-
- Unsupported parameters:
slugowner_screen_nameowner_idinclude_entities
-
- Unsupported parameters:
screen_namecount
-
- Unsupported parameters:
slugnamemodedescriptionowner_screen_nameowner_id
-
- Unsupported parameters:
modedescription
-
- Unsupported parameters:
owner_screen_nameowner_idslug
-
- Unsupported parameters
stringify_ids
-
- Additional parameters:
since_id: You can use thenext_cursorvalue to load the next page.max_id: You can use the inverse of theprevious_cursorvalue to load the previous page.
- Unsupported parameter:
skip_status: No status is returned even if it isn’t set to true.
- Caveats:
cursortrumpssince_idtrumpsmax_idif any combination is provided.user_idmust be the ID of a contact associated with a local user account.screen_namemust be associated with a local user account.screen_nametrumpsuser_idif both are provided (undocumented Twitter behavior).
- Will succeed but return an empty array for users hiding their contact lists.