GET
/
2
/
tweets
/
search
/
stream

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

backfill_minutes
integer

The number of minutes of backfill requested.

Required range: 0 < x < 5
start_time
string

YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided.

end_time
string

YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.

tweet.fields
enum<string>[]

A comma separated list of Tweet fields to display.

Available options:
article,
attachments,
author_id,
card_uri,
context_annotations,
conversation_id,
created_at,
display_text_range,
edit_controls,
edit_history_tweet_ids,
entities,
geo,
id,
in_reply_to_user_id,
lang,
media_metadata,
non_public_metrics,
note_tweet,
organic_metrics,
possibly_sensitive,
promoted_metrics,
public_metrics,
referenced_tweets,
reply_settings,
scopes,
source,
text,
withheld
expansions
enum<string>[]

A comma separated list of fields to expand.

Available options:
article.cover_media,
article.media_entities,
attachments.media_keys,
attachments.media_source_tweet,
attachments.poll_ids,
author_id,
edit_history_tweet_ids,
entities.mentions.username,
geo.place_id,
in_reply_to_user_id,
entities.note.mentions.username,
referenced_tweets.id,
referenced_tweets.id.author_id
media.fields
enum<string>[]

A comma separated list of Media fields to display.

Available options:
alt_text,
duration_ms,
height,
media_key,
non_public_metrics,
organic_metrics,
preview_image_url,
promoted_metrics,
public_metrics,
type,
url,
variants,
width
poll.fields
enum<string>[]

A comma separated list of Poll fields to display.

Available options:
duration_minutes,
end_datetime,
id,
options,
voting_status
user.fields
enum<string>[]

A comma separated list of User fields to display.

Available options:
affiliation,
connection_status,
created_at,
description,
entities,
id,
location,
most_recent_tweet_id,
name,
pinned_tweet_id,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscription_type,
url,
username,
verified,
verified_type,
withheld
place.fields
enum<string>[]

A comma separated list of Place fields to display.

Available options:
contained_within,
country,
country_code,
full_name,
geo,
id,
name,
place_type

Response

200 - application/json

A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that the Tweet matched.

data
object
errors
object[]
includes
object
matching_rules
object[]

The list of rules which matched the Tweet