Little Outliner Verbs

Twitter #

twitter.getUserProfile #

This returns a user profile. You need to specify a user_id OR screen_name for this to work. #

Parameters #

NameRequiredDescriptionExample
user_idrequiredThe ID of the user for whom to return results.12345
screen_namerequiredThe screen name of the user for whom to return results.noradio
include_entitiesoptionalThe entities node will not be included when set to false.false

Example #

var profile = twitter.getUserProfile({ user_id: 12345 });
var profile = twitter.getUserProfile({ screen_name: 'noradio' });
// If first param is not object, we assume it's screen_name
var profile = twitter.getUserProfile('noradio');

twitter.getUserTimeLine #

Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters. #

Parameters #

NameRequiredDescriptionExample
user_idrequiredThe ID of the user for whom to return results.12345
screen_namerequiredThe screen name of the user for whom to return results.noradio
since_idoptionalReturns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets that can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.12345
countoptionalSpecifies the number of Tweets to try and retrieve, up to a maximum of 200 per distinct request. The value of count is best thought of as a limit to the number of Tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if include_rts is not supplied. It is recommended you always send include_rts=1 when using this API method.
max_idoptionalReturns results with an ID less than (that is, older than) or equal to the specified ID.54321
trim_useroptionalWhen set to either true , t or 1 , each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.true
exclude_repliesoptionalThis parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.true
include_rtsoptionalWhen set to false , the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you're using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.false
tweet_modeoptionalWhen set to 'extended', the timeline will include the full_text attribute which is the full (non-truncated) text of the tweets.extended

Example #

var tweets = twitter.getUserTimeLine({ user_id: 12345, tweet_mode: 'extended' });
var tweets = twitter.getUserTimeLine({ screen_name: 'noradio' });
// If first param is not object, we assume it's screen_name
var tweets = twitter.getUserTimeLine('noradio');

twitter.getStatus #

Returns a single Tweet, specified by the id parameter. #

Parameters #

NameRequiredDescriptionExample
idrequiredThe numerical ID of the desired Tweet.123
trim_useroptionalWhen set to either true, t, or 1, each Tweet returned in a timeline will include a user object including only the status author's numerical ID. Omit this parameter to receive the complete user object.true
include_my_retweetoptionalWhen set to either true, t, or 1, any Tweets returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet.true
include_entitiesoptionalThe entities node will not be included when set to false.false
include_ext_alt_textoptionalIf alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity. If no value has been set, this will be returned as `null`true
include_card_urioptionalWhen set to either true, t, or 1, the retrieved Tweet will include a card_uri attribute when there is an ads card attached to the Tweet and when that card was attached using the card_uri value.true
tweet_modeoptionalWhen set to 'extended', the timeline will include the full_text attribute which is the full (non-truncated) text of the tweets.extended

Example #

var tweet = twitter.getStatus({ id: '210462857140252672', tweet_mode: 'extended' });
// If first param is not object, we assume it's id
var tweet = twitter.getStatus('210462857140252672');
Published by Andrew Shell on and last updated .