penicillin/blue.starry.penicillin.endpoints.timeline/listTimeline

listTimeline

fun Timeline.listTimeline(    listId: Long,     sinceId: Long? = null,     maxId: Long? = null,     count: Int? = null,     includeEntities: Boolean? = null,     includeRTs: Boolean? = null,     tweetMode: TweetMode = TweetMode.Default,     includeMyRetweet: Boolean? = null,     includeCardUri: Boolean? = null,     vararg options: Option): JsonArrayApiAction<Status>
Content copied to clipboard

Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets. Embedded Timelines is a great way to embed list timelines on your website.

Twitter API reference

Receiver

Timeline endpoint instance.

Return

JsonArrayApiAction for Status model.

See also

Parameters

listId

The numerical id of the list.

sinceId

Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

maxId

Returns results with an ID less than (that is, older than) or equal to the specified ID.

count

Specifies the number of results to retrieve per "page."

includeEntities

Entities are ON by default in API 1.1, each tweet includes a node called "entities". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit entities from the result by using include_entities=false

includeRTs

When set to either true, t or 1, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets. The output format of retweeted tweets is identical to the representation you see in home_timeline.

options

Optional. Custom parameters of this request.