Trends

class Trends(val client: ApiClient) : Endpoint

Collection of api endpoints related to trends.

See also

Parameters

client

Current ApiClient instance.

Constructors

Link copied to clipboard
fun Trends(client: ApiClient)

Creates new Trends endpoint instance.

Properties

Link copied to clipboard
open override val client: ApiClient

Extensions

Link copied to clipboard
val Trends.availableAreas: JsonArrayApiAction<TrendArea>

Shorthand property to Trends.availableAreas.

fun Trends.availableAreas(vararg options: Option): JsonArrayApiAction<TrendArea>

Returns the locations that Twitter has trending topic information for. The response is an array of "locations" that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in. A WOEID is a Yahoo! Where On Earth ID.

Link copied to clipboard
fun Trends.closestAreas(    latitude: Double,     longitude: Double,     vararg options: Option): JsonArrayApiAction<TrendArea>

Returns the locations that Twitter has trending topic information for, closest to a specified location. The response is an array of "locations" that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in. A WOEID is a Yahoo! Where On Earth ID.

Link copied to clipboard
fun Trends.place(    id: Long,     exclude: TrendExclude = TrendExclude.Default,     vararg options: Option): JsonArrayApiAction<TrendPlace>

Returns the top 50 trending topics for a specific WOEID, if trending information is available for it. The response is an array of trend objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL. This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against rate limit usage. The tweet_volume for the last 24 hours is also returned for many trends if this is available.

Link copied to clipboard
val Trends.plus: JsonObjectApiAction<TrendPlus>

Shorthand property to Trends.plus.

fun Trends.plus(vararg options: Option): JsonObjectApiAction<TrendPlus>

Undocumented endpoint.