Search typeahead suggestions

GET

/2/typeahead

curl --request GET \
  --url 'https://api.fxtwitter.com/2/typeahead?q=example&result_type=events%2Cusers%2Ctopics&src=search_box'

• FxTwitter API host

Autocomplete suggestions from X/Twitter search

Parameters

Query Parameters

q

required

string

Example

example

Prefix or query string

result_type

string

Example

events,users,topics

Comma-separated suggestion kinds to request from X: events, users, topics (default: all three). Other values are ignored. Hashtag-style hits appear under topics.

src

string

Example

search_box

Upstream src hint (default: search_box)

Responses

200

Typeahead payload

Media type application/json

object

code

required

number

query

required

string

num_results

required

number

users

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

id

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

id

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

topics

required

Array<object>

object

topic

required

string

result_context

object

display_string

string

redirect_url

string

types

Array<object>

object

type

required

string

events

required

Array<object>

object

topic

required

string

url

string

supporting_text

string

primary_image

object

url

required

string

width

number

height

number

Example

{
  "users": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}

400

Invalid query parameters

Media type application/json

object

code

required

number

Allowed values: 400

message

required

string

Example

{
  "code": 400
}

404

Upstream returned an error payload for this query

Media type application/json

object

code

required

number

query

required

string

num_results

required

number

users

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

id

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

id

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

topics

required

Array<object>

object

topic

required

string

result_context

object

display_string

string

redirect_url

string

types

Array<object>

object

type

required

string

events

required

Array<object>

object

topic

required

string

url

string

supporting_text

string

primary_image

object

url

required

string

width

number

height

number

Example

{
  "users": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}

500

Upstream or processing error

Media type application/json

object

code

required

number

query

required

string

num_results

required

number

users

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

id

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

id

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

topics

required

Array<object>

object

topic

required

string

result_context

object

display_string

string

redirect_url

string

types

Array<object>

object

type

required

string

events

required

Array<object>

object

topic

required

string

url

string

supporting_text

string

primary_image

object

url

required

string

width

number

height

number

Example

{
  "users": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}