Skip to content
FxEmbed

Get trending topics

GET
/2/trends
 
curl --request GET \
  --url 'https://api.fxtwitter.com/2/trends?type=trending&count=20'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
type
string
default: trending
Allowed values: trending
Example 
trending

Explore timeline kind. Supported: trending

count
integer
default: 20 >= 1 <= 50

Number of trends (default 20, max 50)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Trends payload

Media type application/json
object
code
required
number
message
string
timeline_type
required
string
trends
required
Array<object>
object
name
required
string
rank
required
string
nullable
context
required
string
nullable
grouped_topics
Array<object>
object
name
required
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example generated
{
  "code": 1,
  "message": "example",
  "timeline_type": "example",
  "trends": [
    {
      "name": "example",
      "rank": "example",
      "context": "example",
      "grouped_topics": [
        {
          "name": "example"
        }
      ]
    }
  ],
  "cursor": {
    "top": "example",
    "bottom": "example"
  }
}

400

Section titled “400 ”

Invalid query parameters (e.g. type or count out of allowed range)

Media type application/json
object
code
required
number
Allowed values: 400
message
required
string
Example 
{
  "code": 400
}

404

Section titled “404 ”

Trends unavailable

Media type application/json
object
code
required
number
message
string
timeline_type
required
string
trends
required
Array<object>
object
name
required
string
rank
required
string
nullable
context
required
string
nullable
grouped_topics
Array<object>
object
name
required
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example generated
{
  "code": 1,
  "message": "example",
  "timeline_type": "example",
  "trends": [
    {
      "name": "example",
      "rank": "example",
      "context": "example",
      "grouped_topics": [
        {
          "name": "example"
        }
      ]
    }
  ],
  "cursor": {
    "top": "example",
    "bottom": "example"
  }
}

500

Section titled “500 ”

Upstream or processing error

Media type application/json
object
code
required
number
message
string
timeline_type
required
string
trends
required
Array<object>
object
name
required
string
rank
required
string
nullable
context
required
string
nullable
grouped_topics
Array<object>
object
name
required
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example generated
{
  "code": 1,
  "message": "example",
  "timeline_type": "example",
  "trends": [
    {
      "name": "example",
      "rank": "example",
      "context": "example",
      "grouped_topics": [
        {
          "name": "example"
        }
      ]
    }
  ],
  "cursor": {
    "top": "example",
    "bottom": "example"
  }
}