# `XClient.Trends`
[🔗](https://github.com/iamkanishka/x-client.ex.git/blob/v1.0.0/lib/twitter_client/trends.ex#L1)

Trends operations for X API v1.1.

## Rate Limits

- GET trends/place: 75 per 15 minutes
- GET trends/available: 75 per 15 minutes
- GET trends/closest: 75 per 15 minutes

# `available`

Returns all available trend locations.

## Examples

    {:ok, locations} = XClient.Trends.available()

## Rate Limit

75 requests per 15 minutes

# `closest`

Returns the locations that X has trending topic information for, closest to a specified location.

## Parameters

  - `opts` - Required parameters
    - `:lat` - Latitude
    - `:long` - Longitude

## Examples

    {:ok, locations} = XClient.Trends.closest(lat: 37.781157, long: -122.398720)

## Rate Limit

75 requests per 15 minutes

# `place`

Returns the trending topics for a specific WOEID.

## Parameters

  - `id` - The WOEID (Where On Earth ID) of the location
  - `opts` - Optional parameters
    - `:exclude` - Exclude hashtags from results

## Examples

    # Worldwide trends
    {:ok, trends} = XClient.Trends.place(1)

    # United States trends
    {:ok, trends} = XClient.Trends.place(23424977)

    # New York trends
    {:ok, trends} = XClient.Trends.place(2459115)

## Rate Limit

75 requests per 15 minutes

## Common WOEIDs

- Worldwide: 1
- United States: 23424977
- United Kingdom: 23424975
- Canada: 23424775
- India: 23424848

---

*Consult [api-reference.md](api-reference.md) for complete listing*