Xquik Python SDK

https://github.com/xquik-dev/x-twitter-scraper-python
Admin
Xquik Python SDK is a typed REST client for the X (Twitter) Scraper API, enabling tweet search, user...
Tokens:60,255
Snippets:766
Trust Score:5.5
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### List Monitors Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Example of listing all monitors and iterating through them.

```python
response = client.monitors.list()
print(f"Total monitors: {len(response.monitors)}")

for monitor in response.monitors:
    print(f"- {monitor.username}: {monitor.active}")
```

--------------------------------

### List Webhooks Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/07-webhooks-api.md

Example of iterating through all webhooks associated with the account.

```python
response = client.webhooks.list()
print(f"Total webhooks: {len(response.webhooks)}")

for webhook in response.webhooks:
    print(f"- {webhook.url}")
```

--------------------------------

### Create Monitor Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Example of creating a monitor for a specific user with selected event types.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

monitor = client.monitors.create(
    username="elonmusk",
    event_types=["tweet_created", "follower_gained"]
)

print(f"Monitor ID: {monitor.id}")
print(f"Monitor active: {monitor.active}")
```

--------------------------------

### Create Webhook Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/07-webhooks-api.md

Example of creating a new webhook with a URL and secret.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

webhook = client.webhooks.create(
    url="https://myapp.com/webhook",
    secret="my-webhook-secret"
)

print(f"Webhook ID: {webhook.id}")
print(f"Webhook URL: {webhook.url}")
```

--------------------------------

### Retrieve Monitor Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Example of fetching monitor details using a monitor ID.

```python
monitor = client.monitors.retrieve(id="monitor-id-123")
print(f"Monitor for: {monitor.username}")
print(f"Active: {monitor.active}")
print(f"Subscribed to: {', '.join(monitor.event_types)}")
```

--------------------------------

### Install x-twitter-scraper

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/README.md

Use pip to install the library in your Python environment.

```bash
pip install x_twitter_scraper
```

--------------------------------

### Retrieve search usage example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Example demonstrating how to search for users and iterate through the results.

```python
result = client.x.users.retrieve_search(
    q="elonmusk",
    limit=10
)

for user in result.users:
    print(f"@{user.username}: {user.followers} followers")
```

--------------------------------

### Install aiohttp support

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/README.md

Install the package with aiohttp support for improved concurrency.

```sh
# install from PyPI
pip install x_twitter_scraper[aiohttp]
```

--------------------------------

### Retrieve Followers and Pagination Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Signature and usage example for retrieving user followers with pagination.

```python
def retrieve_followers(
    self,
    id: str,
    *,
    limit: int | Omit = omit,
    next_cursor: str | Omit = omit,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PaginatedUsers
```

```python
# Get first page of followers
result = client.x.users.retrieve_followers(
    id="44196397",
    limit=50
)

print(f"Retrieved {len(result.users)} followers")

# Get all followers with pagination
all_followers = []
next_cursor = None

while True:
    result = client.x.users.retrieve_followers(
        id="44196397",
        limit=100,
        next_cursor=next_cursor
    )
    
    all_followers.extend(result.users)
    
    if not result.has_next_page:
        break
    
    next_cursor = result.next_cursor

print(f"Total followers: {len(all_followers)}")
```

--------------------------------

### Retrieve bookmarks example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Example usage of the retrieve method to fetch a limited number of bookmarks.

```python
bookmarks = client.x.bookmarks.retrieve(limit=20)
print(f"Bookmarks: {len(bookmarks.tweets)}")
```

--------------------------------

### Install python-dotenv

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Install the dependency required to load configuration from a .env file.

```bash
pip install python-dotenv
```

--------------------------------

### Perform Custom GET Requests

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/10-response-handling.md

Demonstrates making GET requests with query parameters and casting responses to dictionaries or raw httpx.Response objects.

```python
import httpx
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

# GET request returning JSON
response = client.get(
    "/custom/endpoint",
    cast_to=dict,  # Cast result to dict
)
print(response)

# GET with query params
response = client.get(
    "/custom/endpoint",
    params={"key": "value"},
    cast_to=dict,
)

# GET returning raw httpx.Response
response = client.get(
    "/custom/endpoint",
    cast_to=httpx.Response,
)
print(response.status_code)
```

--------------------------------

### Retrieve User Profile Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Example usage of the retrieve method to fetch profile details.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

profile = client.x.users.retrieve(id="44196397")  # Elon Musk's user ID
print(f"Name: {profile.name}")
print(f"Username: {profile.username}")
print(f"Followers: {profile.followers}")
print(f"Verified: {profile.is_verified}")
```

--------------------------------

### Retrieve Webhook Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/07-webhooks-api.md

Example of fetching webhook details using a specific ID.

```python
webhook = client.webhooks.retrieve(id="webhook-id-123")
print(f"Webhook URL: {webhook.url}")
print(f"Active: {webhook.active}")
```

--------------------------------

### Retrieve Batch Profiles Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Example usage of the retrieve_batch method to fetch multiple profiles.

```python
result = client.x.users.retrieve_batch(
    ids="44196397,123456789,987654321"
)
for user in result.users:
    print(f"{user.username}: {user.followers} followers")
```

--------------------------------

### Get trending topics

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Example usage for retrieving and printing trending topics.

```python
# Get trends
trends = client.radar.list(limit=10)
for trend in trends.trends:
    print(f"#{trend.name}: {trend.tweet_volume} tweets")
```

--------------------------------

### Example: Create and top up a guest wallet

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Demonstrates creating a wallet and adding funds to it.

```python
# Create wallet
wallet = client.guest_wallets.create()

# Top up balance
result = client.guest_wallets.topup(
    id=wallet.id,
    amount=100.0
)

print(f"Wallet balance: {result.balance}")
```

--------------------------------

### Send direct message example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Example usage of the create method to send a message with a unique idempotency key.

```python
import uuid

result = client.x.dm.create(
    account="@myaccount",
    recipient="123456789",
    text="Hey, how are you?",
    idempotency_key=str(uuid.uuid4())
)
```

--------------------------------

### Manage Support Tickets Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Demonstrates creating, listing, and retrieving support tickets.

```python
# Create ticket
ticket = client.support.tickets.create(
    subject="API issue",
    description="Getting 429 errors"
)

# List tickets
tickets = client.support.tickets.list()

# Get ticket
details = client.support.tickets.retrieve(id=ticket.id)
```

--------------------------------

### GET /monitors/keywords

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all keywords.

```APIDOC
## GET /monitors/keywords

### Description
Lists all keywords.

### Method
GET

### Endpoint
/monitors/keywords
```

--------------------------------

### Bootstrap the development environment

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/CONTRIBUTING.md

Initializes the project by installing supported Python runtimes and locked dependencies.

```sh
./scripts/bootstrap
```

--------------------------------

### Profile API Usage Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Demonstrates retrieving and printing profile details.

```python
profile = client.x.profile.retrieve()
print(f"You: @{profile.username}")
print(f"Followers: {profile.followers}")
```

--------------------------------

### Remove follower usage example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Example demonstrating how to remove a follower using a specific account and idempotency key.

```python
result = client.x.users.remove_follower(
    id="123456789",
    account="@myaccount",
    idempotency_key="unique-remove-key"
)
```

--------------------------------

### Example: List connected X accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Iterates through and prints details of connected accounts.

```python
accounts = client.x.accounts.list()
for account in accounts:
    print(f"@{account.username}: {account.followers} followers")
```

--------------------------------

### GET /styles/compare

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Compares styles.

```APIDOC
## GET /styles/compare

### Description
Compares multiple styles.

### Method
GET

### Endpoint
/styles/compare
```

--------------------------------

### Define .env Configuration File

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Example content for a .env file to store configuration variables.

```text
X_TWITTER_SCRAPER_API_KEY=your-api-key-here
X_TWITTER_SCRAPER_BASE_URL=https://xquik.com/api/v1
X_TWITTER_SCRAPER_LOG=info
```

--------------------------------

### GET /monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all monitors.

```APIDOC
## GET /monitors

### Description
Lists all available monitors.

### Method
GET

### Endpoint
/monitors
```

--------------------------------

### GET /webhooks

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all configured webhooks.

```APIDOC
## GET /webhooks

### Description
Lists all configured webhooks.

### Method
GET

### Endpoint
/webhooks
```

--------------------------------

### GET /styles

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all style profiles.

```APIDOC
## GET /styles

### Description
Lists all style profiles.

### Method
GET

### Endpoint
/styles
```

--------------------------------

### Activating a Subscription Plan

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Example usage of the subscribe method to activate a specific plan.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

response = client.subscribe.subscribe(plan="pro")
print(f"Subscription activated: {response.plan}")
```

--------------------------------

### Top Up Credit Balance

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Signature and usage example for adding credits to the account.

```python
def topup_balance(
    self,
    *,
    amount: int,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> CreditTopupBalanceResponse
```

```python
response = client.credits.topup_balance(amount=1000)
print(f"Added 1000 credits. New balance: {response.balance}")
```

--------------------------------

### Using aiohttp as HTTP Backend

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Installation and usage of the aiohttp backend for improved concurrency.

```bash
pip install x_twitter_scraper[aiohttp]
```

```python
import asyncio
from x_twitter_scraper import DefaultAioHttpClient, AsyncXTwitterScraper

async def main() -> None:
    async with AsyncXTwitterScraper(
        http_client=DefaultAioHttpClient(),
    ) as client:
        tweets = await client.x.tweets.search(
            q="from:elonmusk",
            limit=10
        )
        print(tweets.tweets)

asyncio.run(main())
```

--------------------------------

### GET /x/accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all X accounts.

```APIDOC
## GET /x/accounts

### Description
Returns a list of all configured X accounts.

### Method
GET

### Endpoint
/x/accounts
```

--------------------------------

### Basic XTwitterScraper Usage

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Example of initializing the client using an environment variable and performing a search.

```python
import os
from x_twitter_scraper import XTwitterScraper

# Create client with API key from environment
client = XTwitterScraper(
    api_key=os.environ.get("X_TWITTER_SCRAPER_API_KEY")
)

# Use the client
tweets = client.x.tweets.search(
    q="from:elonmusk",
    limit=10
)
print(tweets.has_next_page)
```

--------------------------------

### Lists API Usage Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Demonstrates retrieving members and adding a user to a list.

```python
# Get list members
members = client.x.lists.retrieve_members(
    list_id="1234567890",
    limit=50
)

# Add member
client.x.lists.add_member(
    list_id="1234567890",
    user_id="987654321",
    account="@myaccount",
    idempotency_key="unique-key"
)
```

--------------------------------

### GET /credits/topup/redirect

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Redirects the user to the topup checkout page.

```APIDOC
## GET /credits/topup/redirect

### Description
Redirects the user to the topup checkout page.

### Method
GET

### Endpoint
/credits/topup/redirect
```

--------------------------------

### Retrieve SDK version information

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Access the installed package version and title metadata.

```python
import x_twitter_scraper

print(x_twitter_scraper.__version__)
print(x_twitter_scraper.__title__)
```

--------------------------------

### Run Giveaway Draw Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Demonstrates extracting participants and running a draw to select winners.

```python
# Extract participants
extraction = client.extractions.run(
    extraction_type="followers",
    query="@myaccount"
)

# Wait for extraction to complete...

# Run draw to select 10 winners
draw = client.draws.run(
    extraction_id=extraction.id,
    winner_count=10
)

# Get results
results = client.draws.retrieve(id=draw.id)
print(f"Winners: {results.winners}")
```

--------------------------------

### GET /x/users/batch

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieve a batch of users.

```APIDOC
## GET /x/users/batch

### Description
Retrieve a batch of users.

### Method
GET

### Endpoint
/x/users/batch
```

--------------------------------

### Basic Async Usage

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Demonstrates initializing the client and performing an asynchronous search operation.

```python
import os
import asyncio
from x_twitter_scraper import AsyncXTwitterScraper

async def main() -> None:
    client = AsyncXTwitterScraper(
        api_key=os.environ.get("X_TWITTER_SCRAPER_API_KEY")
    )
    
    # Use await for async operations
    tweets = await client.x.tweets.search(
        q="from:elonmusk",
        limit=10
    )
    print(tweets.has_next_page)

asyncio.run(main())
```

--------------------------------

### GET /styles/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a style profile.

```APIDOC
## GET /styles/{id}

### Description
Retrieves a style profile by ID.

### Method
GET

### Endpoint
/styles/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the style profile.
```

--------------------------------

### Accessing the MediaResource

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/06-media-api.md

Demonstrates how to access the MediaResource instance from the main client.

```python
client = XTwitterScraper()
client.x.media  # MediaResource instance
```

--------------------------------

### Retrieve Credit Balance

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Signature and usage example for fetching the current credit balance.

```python
def retrieve_balance(
    self,
    *,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> CreditRetrieveBalanceResponse
```

```python
response = client.credits.retrieve_balance()
print(f"Balance: {response.balance} credits")
print(f"Used: {response.used} credits")
```

--------------------------------

### Retrieve Tweet Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/03-tweets-api.md

Demonstrates fetching a specific tweet and accessing its properties.

```python
result = client.x.tweets.retrieve(id="1234567890")
print(f"Tweet text: {result.text}")
print(f"Author: {result.author.name}")
print(f"Likes: {result.like_count}")
```

--------------------------------

### Access SDK Version

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Retrieve the currently installed version of the x_twitter_scraper package.

```python
import x_twitter_scraper

print(x_twitter_scraper.__version__)
```

--------------------------------

### Build project distributions

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/CONTRIBUTING.md

Compiles the project into public distributions using uv.

```sh
uv build
```

--------------------------------

### Verify webhook event signatures

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Example implementation using Flask to verify the X-Xquik-Signature header before processing webhook events.

```python
import hashlib
import hmac
import json
from flask import request

WEBHOOK_SECRET = os.environ.get("XQUIK_WEBHOOK_SECRET")

@app.route("/webhook", methods=["POST"])
def handle_webhook():
    # Verify signature
    signature = request.headers.get("X-Xquik-Signature")
    body = request.get_data(as_text=True)
    
    expected_sig = "sha256=" + hmac.new(
        WEBHOOK_SECRET.encode(),
        body.encode(),
        hashlib.sha256
    ).hexdigest()
    
    if not hmac.compare_digest(signature, expected_sig):
        return {"error": "Invalid signature"}, 401
    
    # Process event
    event = json.loads(body)
    if event["type"] == "tweet_created":
        print(f"New tweet from {event['username']}")
    
    return {"ok": True}
```

--------------------------------

### Multi-account monitoring

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Demonstrates batch creation of monitors and listing all active monitors.

```python
accounts = ["account1", "account2", "account3"]

monitors = []
for account in accounts:
    monitor = client.monitors.create(
        username=account,
        event_types=["tweet_created", "follower_gained"]
    )
    monitors.append(monitor)

print(f"Created {len(monitors)} monitors")

# List all active monitors
all_monitors = client.monitors.list()
print(f"Total monitors: {len(all_monitors.monitors)}")
```

--------------------------------

### Retrieve User Tweets Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/04-users-api.md

Example usage of the retrieve_tweets method to fetch a user's timeline.

```python
result = client.x.users.retrieve_tweets(
    id="44196397",
    limit=20
)
print(f"Latest {len(result.tweets)} tweets from user")
for tweet in result.tweets:
    print(f"- {tweet.text}")
```

--------------------------------

### Set up webhook for monitor events

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/07-webhooks-api.md

Initializes a scraper client, creates a webhook endpoint, and links it to a specific user monitor.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

# 1. Create webhook
webhook = client.webhooks.create(
    url="https://myapp.com/webhooks/monitor",
    secret="my-webhook-secret"
)

# 2. Create monitor pointing to webhook
monitor = client.monitors.create(
    username="elonmusk",
    event_types=["tweet_created", "follower_gained"]
)

# 3. Update monitor with webhook
client.monitors.update(
    id=monitor.id,
    webhook_url=webhook.url
)

print(f"Monitor {monitor.id} will send events to webhook {webhook.id}")
```

--------------------------------

### Redirect Top-up Checkout

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Signature and usage example for obtaining a checkout URL for credit purchases.

```python
def redirect_topup_checkout(
    self,
    *,
    amount: int | Omit = omit,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> CreditRedirectTopupCheckoutResponse
```

```python
response = client.credits.redirect_topup_checkout(amount=5000)
print(f"Checkout URL: {response.checkout_url}")
# Direct user to this URL in browser
```

--------------------------------

### GET /x/communities/search

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Searches for communities.

```APIDOC
## GET /x/communities/search

### Description
Searches for communities.

### Method
GET

### Endpoint
/x/communities/search
```

--------------------------------

### Load Configuration from .env in Python

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Use python-dotenv to load environment variables before initializing the client.

```python
from dotenv import load_dotenv
from x_twitter_scraper import XTwitterScraper

# Load from .env
load_dotenv()

# Client reads from environment
client = XTwitterScraper()
```

--------------------------------

### Search Tweets Example

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/03-tweets-api.md

Demonstrates searching for tweets by a user and handling pagination with cursors.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

# Search tweets from a user
result = client.x.tweets.search(
    q="from:elonmusk",
    limit=10
)

print(f"Found {len(result.tweets)} tweets")
print(f"Has more pages: {result.has_next_page}")

# Fetch next page
if result.has_next_page:
    next_result = client.x.tweets.search(
        q="from:elonmusk",
        limit=10,
        next_cursor=result.next_cursor
    )
```

--------------------------------

### Configure Multiple Accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Initializes multiple client instances with distinct API keys to maintain separate rate limits and credit pools.

```python
from x_twitter_scraper import XTwitterScraper

# Create separate clients for different keys
client1 = XTwitterScraper(api_key="key1")
client2 = XTwitterScraper(api_key="key2")
client3 = XTwitterScraper(api_key="key3")

# Each has separate rate limits and credit pools
```

--------------------------------

### Check installed package version

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/README.md

Use this to verify the currently active version of the library in your Python environment at runtime.

```py
import x_twitter_scraper
print(x_twitter_scraper.__version__)
```

--------------------------------

### Define Extractions run method

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Method signature for starting a new data extraction job.

```python
def run(
    self,
    *,
    extraction_type: str,
    query: str,
    **kwargs
) -> ExtractionRunResponse
```

--------------------------------

### GET /drafts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all drafts.

```APIDOC
## GET /drafts

### Description
Lists all available drafts.

### Method
GET

### Endpoint
/drafts
```

--------------------------------

### Run data extraction

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Start an extraction job for a specific type and query.

```python
# Extract followers
job = client.extractions.run(
    extraction_type="followers",
    query="@elonmusk"
)

print(f"Extraction job: {job.id}")
```

--------------------------------

### GET /support/tickets

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all support tickets.

```APIDOC
## GET /support/tickets

### Description
Lists all support tickets.

### Method
GET

### Endpoint
/support/tickets
```

--------------------------------

### GET /trends

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists current trends.

```APIDOC
## GET /trends

### Description
Lists current trends.

### Method
GET

### Endpoint
/trends
```

--------------------------------

### Configure Authentication Methods

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Initialize the client using either an API key for service-to-service communication or a bearer token for OAuth.

```python
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    api_key="your-api-key"
)
```

```python
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    bearer_token="your-bearer-token"
)
```

--------------------------------

### GET /x/bookmarks

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists bookmarked tweets.

```APIDOC
## GET /x/bookmarks

### Description
Lists bookmarked tweets.

### Method
GET

### Endpoint
/x/bookmarks
```

--------------------------------

### GET /x/communities/tweets

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists tweets from communities.

```APIDOC
## GET /x/communities/tweets

### Description
Lists tweets from communities.

### Method
GET

### Endpoint
/x/communities/tweets
```

--------------------------------

### Access Support API

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Initialize the client and access the support resource.

```python
client = XTwitterScraper()
client.support
```

--------------------------------

### GET /x/followers/check

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Checks the follower status.

```APIDOC
## GET /x/followers/check

### Description
Checks the follower status.

### Method
GET

### Endpoint
/x/followers/check
```

--------------------------------

### GET /x/users/search

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Search for users on X.

```APIDOC
## GET /x/users/search

### Description
Search for users on X.

### Method
GET

### Endpoint
/x/users/search
```

--------------------------------

### Define Guest Wallet create method

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Signature for creating a new guest wallet.

```python
def create(
    self,
    *,
    **kwargs
) -> GuestWallet
```

--------------------------------

### Create Monitor Method Signature

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Sync and Async method signatures for creating a new account monitor.

```python
def create(
    self,
    *,
    event_types: List[EventType],
    username: str,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> MonitorCreateResponse
```

```python
async def create(
    self,
    *,
    event_types: List[EventType],
    username: str,
    extra_headers: Headers | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> MonitorCreateResponse
```

--------------------------------

### GET /draws

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists all available draws.

```APIDOC
## GET /draws

### Description
Lists all available draws.

### Method
GET

### Endpoint
/draws
```

--------------------------------

### Accessing CreditsResource

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Initialize the client and access the credits resource instance.

```python
client = XTwitterScraper()
client.credits  # CreditsResource instance (or access via client.subscribe.credits)
```

--------------------------------

### GET /x/tweets/search

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/00-index.md

Search for tweets on the platform.

```APIDOC
## GET /x/tweets/search

### Description
Search for tweets based on specific criteria.

### Method
GET

### Endpoint
/x/tweets/search
```

--------------------------------

### POST /monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/00-index.md

Create a new monitor.

```APIDOC
## POST /monitors

### Description
Create a new monitoring task.

### Method
POST

### Endpoint
/monitors
```

--------------------------------

### GET /guest-wallets/status

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the status of a guest wallet.

```APIDOC
## GET /guest-wallets/status

### Description
Retrieves the status of a guest wallet.

### Method
GET

### Endpoint
/guest-wallets/status
```

--------------------------------

### GET /credits/topup/status

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the status of a credit topup.

```APIDOC
## GET /credits/topup/status

### Description
Retrieves the status of a credit topup.

### Method
GET

### Endpoint
/credits/topup/status
```

--------------------------------

### GET /credits

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the current credit balance.

```APIDOC
## GET /credits

### Description
Retrieves the current credit balance.

### Method
GET

### Endpoint
/credits
```

--------------------------------

### Define Guest Wallet topup method

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Signature for adding balance to a guest wallet.

```python
def topup(
    self,
    id: str,
    *,
    amount: float,
    **kwargs
) -> GuestWalletTopupResponse
```

--------------------------------

### GET /x/bookmarks/folders

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the folders associated with bookmarks.

```APIDOC
## GET /x/bookmarks/folders

### Description
Retrieves the folders associated with bookmarks.

### Method
GET

### Endpoint
/x/bookmarks/folders
```

--------------------------------

### GET /x/trends

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves current trends on X.

```APIDOC
## GET /x/trends

### Description
Retrieves current trends on X.

### Method
GET

### Endpoint
/x/trends
```

--------------------------------

### Access Guest Wallets API

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Initialize the client and access the guest_wallets resource.

```python
client = XTwitterScraper()
client.guest_wallets
```

--------------------------------

### GET /x/notifications

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the user's notifications.

```APIDOC
## GET /x/notifications

### Description
Retrieves the user's notifications.

### Method
GET

### Endpoint
/x/notifications
```

--------------------------------

### GET /account

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the current account information.

```APIDOC
## GET /account

### Description
Retrieves the current account information.

### Method
GET

### Endpoint
/account

### Response
#### Success Response (200)
- **AccountRetrieveResponse** (object) - The account details.
```

--------------------------------

### POST /x/accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Creates a new X account.

```APIDOC
## POST /x/accounts

### Description
Creates a new X account using the provided parameters.

### Method
POST

### Endpoint
/x/accounts
```

--------------------------------

### GET /credits/balance

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/00-index.md

Retrieve current credit balance.

```APIDOC
## GET /credits/balance

### Description
Retrieve the current account credit balance.

### Method
GET

### Endpoint
/credits/balance
```

--------------------------------

### client.webhooks.create

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/07-webhooks-api.md

Creates a new webhook configuration for receiving monitor events.

```APIDOC
## client.webhooks.create

### Description
Creates a new webhook endpoint to receive notifications for monitor events.

### Parameters
- **url** (string) - Required - The destination URL for the webhook.
- **secret** (string) - Required - The secret used to sign webhook payloads.

### Response
- **webhook** (object) - Returns a webhook object containing the ID and URL.
```

--------------------------------

### POST /credits/topup

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Initiates a balance topup.

```APIDOC
## POST /credits/topup

### Description
Initiates a balance topup.

### Method
POST

### Endpoint
/credits/topup
```

--------------------------------

### GET /support/attachments/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Downloads a support attachment by ID.

```APIDOC
## GET /support/attachments/{id}

### Description
Downloads a support attachment by ID.

### Method
GET

### Endpoint
/support/attachments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the attachment.
```

--------------------------------

### GET /x/tweets

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists tweets based on provided parameters.

```APIDOC
## GET /x/tweets

### Description
Retrieves a paginated list of tweets.

### Method
GET

### Endpoint
/x/tweets
```

--------------------------------

### POST /guest-wallets/topups

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Tops up a guest wallet.

```APIDOC
## POST /guest-wallets/topups

### Description
Tops up a guest wallet.

### Method
POST

### Endpoint
/guest-wallets/topups
```

--------------------------------

### GET /x/timeline

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the user's home timeline.

```APIDOC
## GET /x/timeline

### Description
Retrieves the user's home timeline.

### Method
GET

### Endpoint
/x/timeline
```

--------------------------------

### Import Bookmark Folder Response Type

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Import the response model for retrieving bookmark folders.

```python
from x_twitter_scraper.types.x import BookmarkRetrieveFoldersResponse
```

--------------------------------

### GET /events

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists events based on provided parameters.

```APIDOC
## GET /events

### Description
Lists events based on provided parameters.

### Method
GET

### Endpoint
/events
```

--------------------------------

### GET /monitors/keywords/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a specific keyword by ID.

```APIDOC
## GET /monitors/keywords/{id}

### Description
Retrieves a specific keyword by its ID.

### Method
GET

### Endpoint
/monitors/keywords/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the keyword.
```

--------------------------------

### GET /radar

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves trending topics from the radar service.

```APIDOC
## GET /radar

### Description
Retrieves a list of trending topics.

### Method
GET

### Endpoint
/radar
```

--------------------------------

### Custom HTTP Client Configuration

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Configures a custom base URL and proxy settings using the httpx backend.

```python
import httpx
from x_twitter_scraper import XTwitterScraper, DefaultHttpxClient

client = XTwitterScraper(
    base_url="https://custom.server.com/api/v1",
    http_client=DefaultHttpxClient(
        proxy="http://proxy.example.com:8080",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)
```

--------------------------------

### GET /drafts/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a specific draft by ID.

```APIDOC
## GET /drafts/{id}

### Description
Retrieves the details of a specific draft.

### Method
GET

### Endpoint
/drafts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the draft.
```

--------------------------------

### GET /x/users/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/00-index.md

Retrieve a user profile by ID.

```APIDOC
## GET /x/users/{id}

### Description
Retrieve the profile information for a specific user.

### Method
GET

### Endpoint
/x/users/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.
```

--------------------------------

### Configure certificate verification on Windows

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Explicitly set the certificate path using certifi when default verification fails on Windows.

```python
import certifi
import httpx
from x_twitter_scraper import XTwitterScraper, DefaultHttpxClient

client = XTwitterScraper(
    http_client=DefaultHttpxClient(
        verify=certifi.where()
    )
)
```

--------------------------------

### GET /x/tweets/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/00-index.md

Retrieve a specific tweet by its ID.

```APIDOC
## GET /x/tweets/{id}

### Description
Retrieve a specific tweet by its unique identifier.

### Method
GET

### Endpoint
/x/tweets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tweet.
```

--------------------------------

### Define Accounts list method

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Signature for listing connected X accounts.

```python
def list(
    self,
    *,
    **kwargs
) -> List[XAccount]
```

--------------------------------

### Generate tweet with AI

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Example usage of the compose create method.

```python
result = client.compose.create(
    prompt="Write a funny tweet about Python"
)
print(f"Generated: {result.text}")
```

--------------------------------

### GET /support/tickets/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a specific support ticket by ID.

```APIDOC
## GET /support/tickets/{id}

### Description
Retrieves a specific support ticket by ID.

### Method
GET

### Endpoint
/support/tickets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the ticket.
```

--------------------------------

### Access Profile API

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Initialize the client and access the profile resource module.

```python
client = XTwitterScraper()
client.x.profile
```

--------------------------------

### GET /x/lists/{id}/members

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the members of a specific list.

```APIDOC
## GET /x/lists/{id}/members

### Description
Retrieves the members of a specific list.

### Method
GET

### Endpoint
/x/lists/{id}/members

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list.
```

--------------------------------

### Enable and Configure Logging

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Set logging levels via standard library configuration or environment variables, and customize logger handlers or formats.

```python
import logging

# Enable info-level logging
logging.basicConfig(level=logging.INFO)

# Or via environment
import os
os.environ["X_TWITTER_SCRAPER_LOG"] = "info"

from x_twitter_scraper import XTwitterScraper
client = XTwitterScraper()
```

```python
import logging

logger = logging.getLogger("x_twitter_scraper")
logger.setLevel(logging.DEBUG)

# Add custom handler
handler = logging.FileHandler("sdk.log")
logger.addHandler(handler)
```

```python
import logging

logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
```

--------------------------------

### GET /x/lists/{id}/followers

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the followers of a specific list.

```APIDOC
## GET /x/lists/{id}/followers

### Description
Retrieves the followers of a specific list.

### Method
GET

### Endpoint
/x/lists/{id}/followers

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list.
```

--------------------------------

### create(event_types, username, ...)

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Creates an account monitor to track specific event types for a given X username.

```APIDOC
## create(event_types, username, ...)

### Description
Creates an account monitor. Monitors check X accounts every 1 second and deliver events via webhooks. Creation requires available credits.

### Parameters
- **event_types** (List[EventType]) - Required - Array of event types to subscribe to.
- **username** (str) - Required - X username (without @).
- **extra_headers** (Headers | None) - Optional - Additional HTTP headers.
- **extra_query** (Query | None) - Optional - Additional query parameters.
- **extra_body** (Body | None) - Optional - Additional JSON body properties.
- **timeout** (float | httpx.Timeout | None | NotGiven) - Optional - Override client-level timeout.

### Returns
- **MonitorCreateResponse** - Monitor configuration with ID and webhook details.
```

--------------------------------

### GET /x/communities/{id}/tweets

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists tweets for a specific community.

```APIDOC
## GET /x/communities/{id}/tweets

### Description
Lists tweets for a specific community.

### Method
GET

### Endpoint
/x/communities/{id}/tweets
```

--------------------------------

### GET /x/communities/{id}/info

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves information about a specific community.

```APIDOC
## GET /x/communities/{id}/info

### Description
Retrieves information about a specific community.

### Method
GET

### Endpoint
/x/communities/{id}/info
```

--------------------------------

### POST /guest-wallets

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Creates a new guest wallet.

```APIDOC
## POST /guest-wallets

### Description
Creates a new guest wallet.

### Method
POST

### Endpoint
/guest-wallets
```

--------------------------------

### GET /x/tweets/{id}/replies

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves replies to a specific tweet.

```APIDOC
## GET /x/tweets/{id}/replies

### Description
Returns a list of replies to the specified tweet.

### Method
GET

### Endpoint
/x/tweets/{id}/replies

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tweet.
```

--------------------------------

### Access Bookmarks API

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Initialize the client and access the bookmarks resource module.

```python
client = XTwitterScraper()
client.x.bookmarks
```

--------------------------------

### Perform Custom POST Requests

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/10-response-handling.md

Demonstrates making POST requests with JSON bodies, raw bytes, or custom headers.

```python
import x_twitter_scraper

client = x_twitter_scraper.XTwitterScraper()

# POST with JSON body
response = client.post(
    "/custom/endpoint",
    body={"key": "value"},
    cast_to=dict,
)

# POST with raw bytes
response = client.post(
    "/custom/endpoint",
    body=b"raw data",
    cast_to=httpx.Response,
)

# POST with extra headers
response = client.post(
    "/custom/endpoint",
    body={"key": "value"},
    headers={"X-Custom": "header"},
    cast_to=dict,
)
```

--------------------------------

### GET /x/tweets/{id}/quotes

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves quotes of a specific tweet.

```APIDOC
## GET /x/tweets/{id}/quotes

### Description
Returns a paginated list of tweets that quote the specified tweet.

### Method
GET

### Endpoint
/x/tweets/{id}/quotes

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tweet.
```

--------------------------------

### Configure Proxy via Environment Variables

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Sets proxies globally using standard environment variables.

```bash
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=https://proxy.example.com:8080
```

--------------------------------

### GET /x/write-actions/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a specific write action by its ID.

```APIDOC
## GET /x/write-actions/{id}

### Description
Retrieves a specific write action by its ID.

### Method
GET

### Endpoint
/x/write-actions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the write action to retrieve.
```

--------------------------------

### GET /x/articles/{tweetId}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves a specific article by its tweet ID.

```APIDOC
## GET /x/articles/{tweetId}

### Description
Retrieves a specific article by its tweet ID.

### Method
GET

### Endpoint
/x/articles/{tweetId}

### Parameters
#### Path Parameters
- **tweetId** (string) - Required - The ID of the tweet to retrieve.
```

--------------------------------

### Configure Global and Per-Request Headers

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Set default headers during client initialization or override them for specific requests using extra_headers.

```python
from x_twitter_scraper import XTwitterScraper

client = XTwitterScraper(
    default_headers={
        "X-Custom-Header": "value",
        "User-Agent": "MyApp/1.0"
    }
)
```

```python
result = client.x.tweets.search(
    q="test",
    limit=10,
    extra_headers={"X-Custom": "value"}
)
```

--------------------------------

### GET /webhooks/{id}/deliveries

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists deliveries for a specific webhook.

```APIDOC
## GET /webhooks/{id}/deliveries

### Description
Lists deliveries for a specific webhook.

### Method
GET

### Endpoint
/webhooks/{id}/deliveries

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the webhook.
```

--------------------------------

### GET /draws/{id}/export

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Exports data for a specific draw.

```APIDOC
## GET /draws/{id}/export

### Description
Exports data for a specific draw.

### Method
GET

### Endpoint
/draws/{id}/export

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the draw.
```

--------------------------------

### Initialize XTwitterScraper with API Key

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Initialize the client using automatic environment variable detection or manual override.

```python
from x_twitter_scraper import XTwitterScraper

# Reads from X_TWITTER_SCRAPER_API_KEY automatically
client = XTwitterScraper()
```

```python
client = XTwitterScraper(api_key="your-api-key")
```

--------------------------------

### GET /draws/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the details of a specific draw by its ID.

```APIDOC
## GET /draws/{id}

### Description
Retrieves the details of a specific draw by its ID.

### Method
GET

### Endpoint
/draws/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the draw.
```

--------------------------------

### Accessing MonitorsResource

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

How to access the monitors resource from the main client instance.

```python
client = XTwitterScraper()
client.monitors  # MonitorsResource instance
```

--------------------------------

### GET /extractions

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Lists extraction jobs based on provided parameters.

```APIDOC
## GET /extractions

### Description
Lists extraction jobs based on provided parameters.

### Method
GET

### Endpoint
/extractions
```

--------------------------------

### Configure Custom HTTP Client

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/10-response-handling.md

Inject a custom httpx client instance to handle specific requirements like proxy settings.

```python
import httpx
from x_twitter_scraper import DefaultHttpxClient

# Use custom httpx client
custom_client = DefaultHttpxClient(
    proxy="http://proxy.example.com:8080",
)

result = client.with_options(
    http_client=custom_client
).x.tweets.search(q="test", limit=10)
```

--------------------------------

### GET /events/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves the details of a specific event by its ID.

```APIDOC
## GET /events/{id}

### Description
Retrieves the details of a specific event by its ID.

### Method
GET

### Endpoint
/events/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the event.
```

--------------------------------

### GET /monitors/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves details for a specific monitor by ID.

```APIDOC
## GET /monitors/{id}

### Description
Retrieves a specific monitor by its ID.

### Method
GET

### Endpoint
/monitors/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the monitor.
```

--------------------------------

### Configure Proxy with Authentication

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Includes credentials in the proxy URL string for authenticated proxy access.

```python
from x_twitter_scraper import DefaultHttpxClient
import httpx

client_obj = DefaultHttpxClient(
    proxy="http://username:password@proxy.example.com:8080"
)

client = XTwitterScraper(http_client=client_obj)
```

--------------------------------

### GET /styles/{id}/performance

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/api.md

Retrieves performance metrics for a style.

```APIDOC
## GET /styles/{id}/performance

### Description
Retrieves performance metrics for a specific style profile.

### Method
GET

### Endpoint
/styles/{id}/performance

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the style profile.
```

--------------------------------

### Manage tweet drafts

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Example usage for listing, saving, and deleting drafts.

```python
# List drafts
drafts = client.drafts.list(limit=20)
for draft in drafts.drafts:
    print(f"Draft: {draft.text[:50]}...")

# Save draft
draft = client.drafts.create(
    account="@myaccount",
    text="This is my draft tweet"
)

# Delete draft
client.drafts.delete(
    id=draft.id,
    account="@myaccount"
)
```

--------------------------------

### Environment Variables

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/01-client-initialization.md

Configuration options for the client via environment variables.

```APIDOC
## Environment Variables

### Description
The client automatically reads the following environment variables for configuration:

- **X_TWITTER_SCRAPER_API_KEY**: API key for authentication.
- **X_TWITTER_SCRAPER_BEARER_TOKEN**: Bearer token for authentication.
- **X_TWITTER_SCRAPER_BASE_URL**: Base URL for API requests.
- **X_TWITTER_SCRAPER_LOG**: Enable logging (values: 'info' or 'debug').
- **X_TWITTER_SCRAPER_CUSTOM_HEADERS**: Multiline custom headers (format: 'Header-Name: value\nAnother-Header: value').
```

--------------------------------

### topup_balance()

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/08-subscription-api.md

Purchases a specified number of credits.

```APIDOC
## topup_balance()

### Description
Top up credit balance.

### Parameters
- **amount** (int) - Required - Number of credits to purchase
- **extra_headers** (Headers | None) - Optional - Additional HTTP headers
- **extra_query** (Query | None) - Optional - Additional query parameters
- **extra_body** (Body | None) - Optional - Additional JSON body properties
- **timeout** (float | httpx.Timeout | None | NotGiven) - Optional - Override client-level timeout

### Returns
- **CreditTopupBalanceResponse** - Top-up confirmation with new balance.

### Example
```python
response = client.credits.topup_balance(amount=1000)
print(f"Added 1000 credits. New balance: {response.balance}")
```
```

--------------------------------

### client.monitors.keywords.create

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/05-monitors-api.md

Adds a keyword filter to an existing monitor.

```APIDOC
## client.monitors.keywords.create

### Description
Adds a keyword filter to a monitor to refine the events captured.

### Method
Python SDK Method

### Parameters
- **...** (args) - Required - Keyword filter parameters
```

--------------------------------

### Configure API Key via Environment Variable

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/12-configuration.md

Set the API key for service-to-service authentication using an environment variable.

```bash
export X_TWITTER_SCRAPER_API_KEY="your-api-key"
```

--------------------------------

### client.styles.list()

Source: https://github.com/xquik-dev/x-twitter-scraper-python/blob/main/_autodocs/11-other-resources.md

Retrieves available writing styles.

```APIDOC
### Method
`client.styles.list(limit: int | Omit = omit)`

### Description
Get writing styles.

### Parameters
- **limit** (int) - Optional - Maximum number of styles to return
```
Tokens:
Raw