Skip to main content
GET
/
2
/
tweets
/
search
/
stream
Stream filtered Posts
curl --request GET \
  --url https://api.x.com/2/tweets/search/stream \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "author_id": "2244994945",
    "created_at": "Wed Jan 06 18:40:40 +0000 2021",
    "id": "1346889436626259968",
    "text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
    "username": "XDevelopers"
  },
  "errors": [
    {
      "detail": "<string>",
      "status": 123,
      "title": "<string>",
      "type": "<string>"
    }
  ],
  "includes": {
    "media": [
      {
        "height": 1,
        "media_key": "<string>",
        "type": "<string>",
        "width": 1
      }
    ],
    "places": [
      {
        "contained_within": [
          "f7eb2fa2fea288b1"
        ],
        "country": "United States",
        "country_code": "US",
        "full_name": "Lakewood, CO",
        "geo": {
          "bbox": [
            -105.193475,
            39.60973,
            -105.053164,
            39.761974
          ],
          "geometry": {
            "coordinates": [
              -105.18816086351444,
              40.247749999999996
            ],
            "type": "Point"
          },
          "properties": {},
          "type": "Feature"
        },
        "id": "f7eb2fa2fea288b1",
        "name": "Lakewood",
        "place_type": "city"
      }
    ],
    "polls": [
      {
        "duration_minutes": 5042,
        "end_datetime": "2023-11-07T05:31:56Z",
        "id": "1365059861688410112",
        "options": [
          {
            "label": "<string>",
            "position": 123,
            "votes": 123
          }
        ],
        "voting_status": "open"
      }
    ],
    "topics": [
      {
        "description": "All about technology",
        "id": "<string>",
        "name": "Technology"
      }
    ],
    "tweets": [
      {
        "author_id": "2244994945",
        "created_at": "Wed Jan 06 18:40:40 +0000 2021",
        "id": "1346889436626259968",
        "text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
        "username": "XDevelopers"
      }
    ],
    "users": [
      {
        "created_at": "2013-12-14T04:35:55Z",
        "id": "2244994945",
        "name": "X Dev",
        "protected": false,
        "username": "TwitterDev"
      }
    ]
  },
  "matching_rules": [
    {
      "id": "120897978112909812",
      "tag": "Non-retweeted coffee Posts"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
backfill_minutes
integer
Required range: 0 <= x <= 5
​
start_time
string<date-time>
​
end_time
string<date-time>
​
tweet.fields
enum<string>[]
Minimum length: 1
Example:
​
expansions
enum<string>[]
Minimum length: 1
Example:
​
media.fields
enum<string>[]
Minimum length: 1
Example:
​
poll.fields
enum<string>[]
Minimum length: 1
Example:
​
user.fields
enum<string>[]
Minimum length: 1
Example:
​
place.fields
enum<string>[]
Minimum length: 1
Example:

Response

​
data
object
Example:
​
errors
object[]
Minimum length: 1
​
includes
object
​
matching_rules
object[]