X API & Twitter API Python SDK by Xquik

Install the Twitter API for Python

pip install x_twitter_scraper

Search tweets with the Python Twitter API

import os
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    api_key=os.environ.get("X_TWITTER_SCRAPER_API_KEY"),  # Optional. The client reads this variable.
)

response = client.x.tweets.search(
    q="from:elonmusk",
    limit=10,
)
for tweet in response.tweets:
    print(tweet.id, tweet.text)

Benchmarks & usage

Move from Tweepy

# Tweepy: client.search_recent_tweets(query="from:NASA", max_results=10)
response = client.x.tweets.search(q="from:NASA", limit=10)

Replace snscrape for Twitter search

# snscrape: TwitterSearchScraper("from:NASA since:2026-10-01").get_items()
response = client.x.tweets.search(q="from:NASA since:2026-10-01", limit=25)
for tweet in response.tweets:
    print(tweet.id, tweet.text)

Common Twitter & X tasks

AI agent workflows with MCP

Async usage

import os
import asyncio
from x_twitter_scraper import AsyncXTwitterScraper

client = AsyncXTwitterScraper(
    api_key=os.environ.get("X_TWITTER_SCRAPER_API_KEY"),  # Optional. The client reads this variable.
)


async def main() -> None:
    response = await client.x.tweets.search(
        q="from:elonmusk",
        limit=10,
    )


asyncio.run(main())

With aiohttp

pip install x_twitter_scraper[aiohttp]

import os
import asyncio
from x_twitter_scraper import DefaultAioHttpClient
from x_twitter_scraper import AsyncXTwitterScraper


async def main() -> None:
    async with AsyncXTwitterScraper(
        api_key=os.environ.get("X_TWITTER_SCRAPER_API_KEY"),  # Optional. The client reads this variable.
        http_client=DefaultAioHttpClient(),
    ) as client:
        response = await client.x.tweets.search(
            q="from:elonmusk",
            limit=10,
        )


asyncio.run(main())

Using types

File uploads

import httpx
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper()

image = httpx.get("https://xquik.com/logo.png").content

client.x.media.upload(
    account="@elonmusk",
    file=("logo.png", image, "image/png"),
    idempotency_key="upload-2026-10-15",
)

Handling errors

import x_twitter_scraper
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper()

try:
    client.x.tweets.search(
        q="from:elonmusk",
        limit=10,
    )
except x_twitter_scraper.APIConnectionError as e:
    print("Could not reach the server. Check the connection.")
    print(e.__cause__)  # Underlying httpx exception.
except x_twitter_scraper.RateLimitError as e:
    print("Rate limited. Retry later.")
except x_twitter_scraper.APIStatusError as e:
    print("Server returned a non-2xx status.")
    print(e.status_code)
    print(e.response)

Retries

from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    max_retries=0,
)

client.with_options(max_retries=5).x.tweets.search(
    q="from:elonmusk",
    limit=10,
)

Timeouts

import httpx
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    timeout=20.0,
)

client = XTwitterScraper(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

client.with_options(timeout=5.0).x.tweets.search(
    q="from:elonmusk",
    limit=10,
)

Advanced

Logging

export X_TWITTER_SCRAPER_LOG=info

Distinguishing None, null & missing fields

response = client.x.tweets.search(q="from:NASA", limit=1)
tweet = response.tweets[0]

if tweet.community_note is None:
    if "community_note" not in tweet.model_fields_set:
        print('The response omitted "community_note".')
    else:
        print('The response set "community_note" to null.')

Accessing raw response data

from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper()
response = client.x.tweets.with_raw_response.search(
    q="from:elonmusk",
    limit=10,
)
print(response.headers.get("X-My-Header"))

tweet = response.parse()  # Parse the regular x.tweets.search() result.
print(tweet.has_next_page)

.with_streaming_response

with client.x.tweets.with_streaming_response.search(
    q="from:elonmusk",
    limit=10,
) as response:
    print(response.headers.get("X-My-Header"))

    for line in response.iter_lines():
        print(line)

Making custom or undocumented requests

Undocumented endpoints

import httpx

response = client.get(
    "/x/tweets/search",
    cast_to=httpx.Response,
    options={"params": {"q": "from:NASA", "limit": 1}},
)

print(response.headers.get("content-type"))

Undocumented request parameters

Undocumented response properties

Configuring the HTTP client

import httpx
from x_twitter_scraper import XTwitterScraper, DefaultHttpxClient

client = XTwitterScraper(
    # Or use the `X_TWITTER_SCRAPER_BASE_URL` env var
    base_url="http://my.test.server.example.com:8083",
    http_client=DefaultHttpxClient(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

from x_twitter_scraper import DefaultHttpxClient

client.with_options(http_client=DefaultHttpxClient(timeout=30.0)).x.tweets.search(
    q="from:NASA",
    limit=10,
)

Managing HTTP resources

from x_twitter_scraper import XTwitterScraper

with XTwitterScraper() as client:
    # Make requests here.
    ...

# The HTTP client is closed.

Versioning

Determining the installed version

import x_twitter_scraper

print(x_twitter_scraper.__version__)

Questions

Do I need an X developer account?

Is this the official X API?

More Xquik tools

Help & contributing