penicillin/blue.starry.penicillin.endpoints.trends

Package blue.starry.penicillin.endpoints.trends

Types

Link copied to clipboard
enum TrendExclude : Enum<TrendExclude> , EnumRequestParameter
Content copied to clipboard

Setting this equal to hashtags will remove all hashtags from the trends list.

Functions

Link copied to clipboard
fun Trends.availableAreas(vararg options: Option): JsonArrayApiAction<TrendArea>
Content copied to clipboard

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>
Content copied to clipboard

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>
Content copied to clipboard

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
fun Trends.plus(vararg options: Option): JsonObjectApiAction<TrendPlus>
Content copied to clipboard

Undocumented endpoint.

Properties

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

Shorthand property to Trends.availableAreas.

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

Shorthand property to Trends.plus.