X Twitter Scraper

https://github.com/xquik-dev/x-twitter-scraper-typescript
Admin
X Twitter Scraper is a TypeScript SDK for accessing the Xquik X (Twitter) Scraper API, enabling...
Tokens:77,907
Snippets:937
Trust Score:5.5
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies and build

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

Initial setup commands to install project dependencies and build the distribution files.

```sh
pnpm install
pnpm build
```

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

### Download Media Examples

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-media.md

Examples for downloading media and retrieving file metadata.

```typescript
const response = await client.x.media.download('media-id');

// Save to file (Node.js)
const fs = require('fs');
const buffer = await response.arrayBuffer();
fs.writeFileSync('downloaded-media.jpg', Buffer.from(buffer));
```

```typescript
const response = await client.x.media.download('media-id', {
  metadataOnly: true,
});

console.log('File size:', response.size);
console.log('Type:', response.type);
```

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

### Install or link the repository

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

Methods for installing the package from Git or linking a local clone for development.

```sh
npm install git+ssh://git@github.com:Xquik-dev/x-twitter-scraper-typescript.git
```

```sh
# Clone.
git clone https://www.github.com/Xquik-dev/x-twitter-scraper-typescript
cd x-twitter-scraper-typescript

# Use Yarn.
yarn link
cd ../my-package
yarn link x-twitter-scraper

# Use pnpm.
pnpm link --global
cd ../my-package
pnpm link --global x-twitter-scraper
```

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

### Create and run a new example

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

Commands to create a new TypeScript example file and execute it using the project's runner.

```ts
// add an example to examples/<your-example>.ts

#!/usr/bin/env -S npm run tsn -T
…
```

```sh
chmod +x examples/<your-example>.ts
# Run the example against your API.
pnpm tsn -T examples/<your-example>.ts
```

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

### Install Xquik Skills via Pi

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

Use the Pi CLI to install the bundled Xquik Skills package from npm.

```sh
pi install npm:x-twitter-scraper
```

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

### Retrieve Media Example

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Example usage for fetching media tweets and logging their types.

```typescript
const response = await client.x.users.retrieveMedia('elonmusk');
response.data.forEach(tweet => {
  console.log(`Tweet: ${tweet.text}`);
  tweet.media?.forEach(m => console.log(`  - ${m.type}`));
});
```

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

### Retrieve Replies Example

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Example usage for fetching replies for a specific user.

```typescript
const response = await client.x.users.retrieveReplies('elonmusk');
console.log(`Found ${response.data.length} replies`);
```

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

### Retrieve Verified Followers Example

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Example usage for fetching verified followers with a limit.

```typescript
const response = await client.x.users.retrieveVerifiedFollowers('elonmusk', {
  limit: 50,
});

console.log('Verified followers:', response.data.length);
```

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

### Install SDK Dependency

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

Command to install the x-twitter-scraper package via npm.

```bash
npm install x-twitter-scraper
```

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

### GET /monitors/keywords

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

Lists all keywords.

```APIDOC
## GET /monitors/keywords

### Description
Lists all keywords.

### Method
GET

### Endpoint
/monitors/keywords
```

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

### Retrieve Mentions Example

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Example usage for fetching mentions of a user.

```typescript
const response = await client.x.users.retrieveMentions('elonmusk', {
  limit: 100,
});

response.data.forEach(tweet => {
  console.log(`@${tweet.author?.username} mentioned @elonmusk`);
});
```

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

### GET /x/profile

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

Get authenticated profile.

```APIDOC
## GET /x/profile

### Description
Get authenticated profile.

### Method
GET

### Endpoint
/x/profile
```

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

### GET /x/timeline

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

Get authenticated home timeline.

```APIDOC
## GET /x/timeline

### Description
Get authenticated home timeline.

### Method
GET

### Endpoint
/x/timeline
```

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

### GET /styles/compare

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

Compares styles.

```APIDOC
## GET /styles/compare

### Description
Compares styles.

### Method
GET

### Endpoint
/styles/compare
```

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

### GET /styles

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

Lists all style profiles.

```APIDOC
## GET /styles

### Description
Lists all style profiles.

### Method
GET

### Endpoint
/styles
```

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

### GET /monitors

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

Lists all monitors.

```APIDOC
## GET /monitors

### Description
Lists all monitors.

### Method
GET

### Endpoint
/monitors
```

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

### docs

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-tools.md

Searches public Xquik documentation for product behavior, setup, and workflow guidance.

```APIDOC
## docs

### Description
Searches public Xquik documentation based on a provided query.

### Parameters
- **query** (string) - Required - A concise documentation query string.

### Request Example
{ "query": "MCP OAuth setup" }
```

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

### Start Webhook Server

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/webhooks.md

Run the webhook server on infrastructure you control to facilitate local testing.

```bash
# Start your webhook server on infrastructure you control
node server.js  # listening on :3000
```

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

### Retrieve Tweets Example

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Example usage for fetching a user's timeline with filtering options.

```typescript
const response = await client.x.users.retrieveTweets('elonmusk', {
  limit: 50,
  excludeReplies: true,
  excludeRetweets: true,
});

response.data.forEach(tweet => {
  console.log(`${tweet.text.substring(0, 80)}...`);
});
```

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

### GET /credits/topup/redirect

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/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
```

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

### get<Rsp>(path: string, opts?: RequestOptions): APIPromise<Rsp>

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

Performs a GET request to the specified path.

```APIDOC
## get<Rsp>(path: string, opts?: RequestOptions)

### Description
Performs a GET request to the specified path.

### Parameters
- **path** (string) - Required - URL path
- **opts** (RequestOptions) - Optional - Optional request options
```

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

### GET /x/bookmarks/folders

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

Retrieves bookmark folders.

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

### Description
Retrieves a list of bookmark folders associated with the account.

### Method
GET

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

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

### GET /drafts

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

Lists all drafts.

```APIDOC
## GET /drafts

### Description
Lists all drafts.

### Method
GET

### Endpoint
/drafts
```

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

### GET /x/users/batch

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

Retrieves a batch of user profiles.

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

### Description
Retrieves a batch of user profiles.

### Method
GET

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

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

### GET /guest-wallets/status

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

Retrieves the status of a guest wallet.

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

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

### Method
GET

### Endpoint
/guest-wallets/status

### Response
#### Success Response (200)
- **GuestWalletRetrieveStatusResponse** (object) - The response object containing the wallet status.
```

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

### GET /credits

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Checks the current credit balance.

```APIDOC
## GET /credits

### Description
Retrieves the current account credit balance.

### Method
GET

### Endpoint
/credits
```

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

### Set X Username

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-account.md

Provides examples of valid and invalid username formats for linking an X account.

```typescript
// Correct - just the username
await client.account.setXUsername({ username: 'elonmusk' });

// Incorrect - these will fail
// await client.account.setXUsername({ username: '@elonmusk' });  // Don't include @
// await client.account.setXUsername({ username: 'https://x.com/elonmusk' });  // Don't include URL
```

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

### Import package types

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

Example of importing various domain types from the x-twitter-scraper package.

```typescript
import type {
  PaginatedTweets,
  PaginatedUsers,
  UserProfile,
  TweetDetail,
  TweetAuthor,
  TweetMedia,
  EmbeddedTweet,
  ContentDisclosure,
  ExtractionJob,
  Webhook,
  Delivery,
  Monitor,
  Draft,
  DraftDetail,
  DrawDetail,
  Winner,
  StyleProfile,
  StyleProfileSummary,
  EventDetail,
  RadarItem,
} from 'x-twitter-scraper';
```

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

### GET /x/dm/{userId}/history

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Get DM conversation history with a user.

```APIDOC
## GET /x/dm/{userId}/history

### Description
Get DM conversation history with a user. Requires a connected X account.

### Method
GET

### Endpoint
/x/dm/{userId}/history
```

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

### Start Data Extraction

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

Estimate the cost of an extraction job before initiating it.

```typescript
const estimate = await client.extractions.estimateCost({
  toolType: 'follower_explorer',
  targetUsername: 'elonmusk',
});

if (estimate.allowed) {
  const job = await client.extractions.run({
    toolType: 'follower_explorer',
    targetUsername: 'elonmusk',
  });
}
```

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

### Configure Real-time Monitoring and Webhooks

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Demonstrates creating persistent monitors, registering webhooks for event delivery, and polling for events as an alternative. Ensure the webhook secret is saved immediately upon registration as it is only displayed once.

```javascript
// 1. Create monitor (persistent resource; active monitors are metered hourly)
const monitor = await xquikFetch('/monitors', {
  method: 'POST',
  body: JSON.stringify({
    username: 'elonmusk',
    eventTypes: ['tweet.new', 'tweet.reply', 'tweet.quote', 'tweet.retweet'],
  }),
});

// 2. Register webhook (persistent delivery destination)
const webhook = await xquikFetch('/webhooks', {
  method: 'POST',
  body: JSON.stringify({
    url: 'https://your-server.com/webhook',
    eventTypes: ['tweet.new', 'tweet.reply'],
  }),
});
// IMPORTANT: Save webhook.secret. It is shown only once!

// 3. Poll events (alternative to webhooks)
const events = await xquikFetch('/events?monitorId=7&limit=50');
```

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

### GET /styles/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-tweet-style-cache.md

Get a cached style profile with full tweet data.

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

### Description
Get a cached style profile with full tweet data. id is the cached style label or username.

### Method
GET

### Endpoint
/styles/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Cached style label or username

### Response
#### Success Response (200)
- **style** (object) - Full style object with tweets array
```

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

### Connect Xquik MCP with OpenAI Agents SDK

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Programmatic setup for the OpenAI Agents SDK using an API key for authentication.

```python
from agents import Agent, Runner
from agents.mcp import MCPServerStreamableHttp


async def run_xquik(api_key: str) -> str:
    async with MCPServerStreamableHttp(
        name="Xquik",
        params={
            "url": "https://xquik.com/mcp",
            "headers": {"Authorization": f"Bearer {api_key}"},
        },
    ) as server:
        agent = Agent(
            name="Xquik agent",
            instructions="Use Xquik to inspect the API catalog.",
            mcp_servers=[server],
        )
        result = await Runner.run(agent, "List the endpoint categories.")
        return str(result.final_output)
```

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

### Get Bookmark Folders Endpoint

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-api.md

Retrieves bookmark folders for the authenticated account.

```http
GET /x/bookmarks/folders
```

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

### Configure and Authenticate OpenCode MCP

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Add the server to opencode.json and use the CLI to authenticate and list servers.

```json
{
  "mcp": {
    "xquik": {
      "type": "remote",
      "url": "https://xquik.com/mcp"
    }
  }
}
```

```bash
opencode mcp auth xquik
opencode mcp list
```

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

### Configure GitHub Copilot CLI MCP

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Use the CLI command to add the xquik MCP server.

```bash
copilot mcp add --transport http xquik https://xquik.com/mcp
```

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

### client.monitors.create

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

Creates a new monitor for specific keywords with a webhook callback.

```APIDOC
## client.monitors.create(params)

### Description
Sets up a keyword monitor.

### Parameters
- **name** (string) - Required - Monitor name.
- **type** (string) - Required - Monitor type (e.g., 'keyword').
- **keywords** (Array) - Required - List of keywords to track.
- **webhook_url** (string) - Required - URL to receive alerts.
```

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

### Run Extraction Methods

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-extractions.md

Examples of initiating different types of extraction jobs using the run method.

```typescript
run(params: ExtractionRunParams, options?: RequestOptions): APIPromise<ExtractionRunResponse>
```

```typescript
const response = await client.extractions.run({
  toolType: 'follower_explorer',
  targetUsername: 'elonmusk',
});

console.log('Job allowed:', response.allowed);
console.log('Credits required:', response.creditsRequired);
console.log('Estimated followers:', response.estimatedResults);
console.log('Resolved X ID:', response.resolvedXUserId);
```

```typescript
const response = await client.extractions.run({
  toolType: 'post_extractor',
  targetUsername: 'elonmusk',
  resultsLimit: 5000,
});

console.log('Extraction allowed:', response.allowed);
```

```typescript
const response = await client.extractions.run({
  toolType: 'tweet_search_extractor',
  q: 'TypeScript AI',
  resultsLimit: 1000,
});

console.log('Search extraction started');
```

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

### Authenticate with Xquik API

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Initializes the API key from environment variables and sets up standard headers for requests.

```javascript
const apiKey = process.env.XQUIK_API_KEY;
if (!apiKey) throw new Error('Set XQUIK_API_KEY first.');

const BASE = 'https://xquik.com/api/v1';
const headers = { 'x-api-key': apiKey, 'Content-Type': 'application/json' };
```

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

### Perform GET Request

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

Execute a GET request to a specific API path and return a promise-like response object.

```typescript
const result = await client.get('/x/tweets/12345');
```

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

### Configure runtime-specific proxies

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

Apply proxy settings via fetchOptions for Node.js, Bun, and Deno environments.

```ts
import XTwitterScraper from 'x-twitter-scraper';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new XTwitterScraper({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});
```

```ts
import XTwitterScraper from 'x-twitter-scraper';

const client = new XTwitterScraper({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});
```

```ts
import XTwitterScraper from 'npm:x-twitter-scraper';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new XTwitterScraper({
  fetchOptions: {
    client: httpClient,
  },
});
```

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

### Run tests and reproducibility checks

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

Commands to execute the test suite and verify build reproducibility.

```sh
pnpm run test
```

```sh
pnpm run check:reproducible
```

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

### POST /x/accounts

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

Creates a new X account.

```APIDOC
## POST /x/accounts

### Description
Creates a new X account.

### Method
POST

### Endpoint
/x/accounts
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-tweet-style-cache.md

Get live engagement metrics for cached tweets for a cached style label or username. Consumes metered API usage.

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

### Description
Get live engagement metrics for cached tweets for a cached style label or username. Consumes metered API usage.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (string) - Required - Cached style label or username

### Response
#### Success Response (200)
- **xUsername** (string) - X username
- **tweetCount** (number) - Number of tweets
- **tweets** (array) - List of tweets with engagement metrics
```

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

### GET /x/communities/search

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

Searches for communities.

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

### Description
Searches for communities.

### Method
GET

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

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

### constructor(opts?: ClientOptions)

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

Initializes a new instance of the XTwitterScraper client with optional configuration settings.

```APIDOC
## constructor(opts?: ClientOptions)

### Description
Initializes a new client instance with optional configuration.

### Parameters
- **opts** (ClientOptions) - Optional - Configuration options for the client (default: {})
```

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

### POST /monitors

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

Creates a new monitor.

```APIDOC
## POST /monitors

### Description
Creates a new monitor.

### Method
POST

### Endpoint
/monitors
```

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

### GET /draws

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

Lists all draws.

```APIDOC
## GET /draws

### Description
Retrieves a list of draws.

### Method
GET

### Endpoint
/draws
```

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

### Prepare files from various sources

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-media.md

Demonstrates obtaining file data from Node.js streams, remote URLs, and browser file inputs.

```typescript
import fs from 'fs';
import fetch from 'node-fetch';

// Node.js file stream
const stream = fs.createReadStream('photo.jpg');

// URL (fetch in Node.js)
const response = await fetch('https://example.com/image.jpg');
const file = await response.blob();

// Form input (browser)
const input = document.querySelector('input[type=file]');
const browserFile = input.files[0];
```

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

### Core Resources

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

Overview of the available SDK resources and their supported methods.

```APIDOC
## Core Resources

### Description
The SDK exposes several namespaces for interacting with Twitter data.

### Resources
- **client.x.tweets**: create, retrieve, list, delete, search, getFavoriters, getQuotes, getReplies, getRetweeters, getThread
- **client.x.users**: retrieve, retrieveBatch, retrieveFollowers, retrieveFollowing, retrieveTweets, retrieveLikes, search
- **client.x.media**: upload, download
- **client.account**: retrieve, setXUsername, updateLocale
- **client.extractions**: run, retrieve, list, estimateCost, exportResults
- **client.monitors**: create, retrieve, list, update, deactivate
- **client.webhooks**: create, retrieve, list, update, deactivate, test
- **client.drafts**: create, retrieve, list, delete
- **client.draws**: create, retrieve, list, run, export
```

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

### POST /guest-wallets/topups

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

Tops up a guest wallet.

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

### Description
Performs a top-up operation on a guest wallet.

### Method
POST

### Endpoint
/guest-wallets/topups

### Response
#### Success Response (200)
- **GuestWalletTopupResponse** (object) - The response object containing the result of the top-up.
```

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

### GET /support/tickets

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

Lists all support tickets.

```APIDOC
## GET /support/tickets

### Description
Lists all support tickets.

### Method
GET

### Endpoint
/support/tickets

### Response
#### Success Response (200)
- **TicketListResponse** (object) - The response object containing a list of tickets.
```

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

### client.x.users.follow.create(params)

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-users.md

Follows a user on the platform.

```APIDOC
## client.x.users.follow.create(params)

### Description
Follows a user using the provided parameters.

### Method
SDK Method

### Parameters
- **params** (object) - Required - The parameters required to perform the follow action.
```

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

### POST /monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Creates a persistent monitor for an X account. Active monitors are metered hourly.

```APIDOC
## POST /monitors

### Description
Creates a persistent monitor for a specific X account to track events.

### Method
POST

### Endpoint
/monitors

### Request Body
- **username** (string) - Required - The X username to monitor.
- **eventTypes** (array) - Required - List of event types to track (e.g., tweet.new, tweet.reply, tweet.quote, tweet.retweet).
```

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

### GET /x/bookmarks

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

Lists bookmarked tweets.

```APIDOC
## GET /x/bookmarks

### Description
Retrieves a paginated list of bookmarked tweets.

### Method
GET

### Endpoint
/x/bookmarks
```

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

### GET /x/communities/tweets

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

Lists tweets from communities.

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

### Description
Lists tweets from communities.

### Method
GET

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

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

### GET /x/followers/check

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

Checks follower status.

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

### Description
Checks the follower status for the specified parameters.

### Method
GET

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

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

### Initialize client and search tweets

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

Basic client initialization and tweet search execution. The client automatically reads the API key from the environment variable.

```js
import XTwitterScraper from 'x-twitter-scraper';

const client = new XTwitterScraper({
  apiKey: process.env['X_TWITTER_SCRAPER_API_KEY'], // Optional; the client reads this variable.
});

const response = await client.x.tweets.search({ q: 'from:elonmusk', limit: 10 });
```

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

### POST /x/communities

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Create a new community.

```APIDOC
## POST /x/communities

### Description
Create a new community.

### Method
POST

### Endpoint
/x/communities

### Request Body
- **account** (string) - Required - Connected X username or account ID
- **name** (string) - Required - Community name
- **description** (string) - Required - Community description
```

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

### GET /credits/topup/status

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/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

### Response
#### Success Response (200)
- **CreditRetrieveTopupStatusResponse** (object) - The response object containing topup status.
```

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

### Retrieve Monitor Billing Information

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-account.md

Demonstrates how to fetch account details and access billing metrics.

```typescript
const account = await client.account.retrieve();
console.log(`Each active monitor costs ${account.monitorBilling.creditsPerActiveMonitorHour} credits/hour`);
console.log(`Current burn rate: ${account.monitorBilling.activeHourlyBurn} credits/hour`);
```

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

### POST /guest-wallets

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

Creates a new guest wallet.

```APIDOC
## POST /guest-wallets

### Description
Creates a new guest wallet.

### Method
POST

### Endpoint
/guest-wallets

### Response
#### Success Response (200)
- **GuestWalletCreateResponse** (object) - The response object containing details of the created wallet.
```

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

### GET /events

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Polls for events as an alternative to webhooks.

```APIDOC
## GET /events

### Description
Polls for events associated with monitors.

### Method
GET

### Endpoint
/events

### Query Parameters
- **monitorId** (string) - Optional - The ID of the monitor to poll.
- **limit** (number) - Optional - The maximum number of events to return.
```

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

### GET /x/tweets

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

Retrieve specific tweets by their IDs.

```APIDOC
## GET /x/tweets

### Description
Retrieve details for specific tweets using a comma-separated list of IDs.

### Method
GET

### Endpoint
/x/tweets

### Query Parameters
- **ids** (string) - Required - Comma-separated list of tweet IDs.

### Response
#### Success Response (200)
- **data** (array) - List of tweet objects.

### Response Example
{
  "data": []
}
```

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

### Proxy Configuration

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

Configure proxy settings for Node.js, Bun, and Deno environments.

```typescript
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new XTwitterScraper({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});
```

```typescript
const client = new XTwitterScraper({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});
```

```typescript
const httpClient = Deno.createHttpClient({
  proxy: { url: 'http://localhost:8888' },
});
const client = new XTwitterScraper({
  fetchOptions: {
    client: httpClient,
  },
});
```

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

### GET /webhooks

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-webhooks.md

Retrieves a list of all registered webhooks.

```APIDOC
## GET /webhooks

### Description
Returns a list of all registered webhooks, up to a maximum of 200. Note that the secret is not exposed in this response.

### Method
GET

### Endpoint
/webhooks
```

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

### run(params: ExtractionRunParams, options?: RequestOptions)

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/_autodocs/resources-extractions.md

Starts a new extraction job with the specified tool and target parameters.

```APIDOC
## run(params: ExtractionRunParams, options?: RequestOptions)

### Description
Starts a new extraction job with the specified tool and target parameters. Supports 23 tool types for extracting followers, tweets, search results, and more.

### Parameters
- **params** (ExtractionRunParams) - Required - Extraction configuration
- **options** (RequestOptions) - Optional - Optional request configuration

### Returns
APIPromise<ExtractionRunResponse> - Job status, cost, and estimated result count.

### Example
```typescript
const response = await client.extractions.run({
  toolType: 'follower_explorer',
  targetUsername: 'elonmusk',
});
```
```

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

### Configure API Key Authentication

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

Initialize the client using an API key provided in the constructor or via environment variables.

```typescript
const client = new XTwitterScraper({
  apiKey: 'sk_...',
});
```

```bash
export X_TWITTER_SCRAPER_API_KEY=sk_...
```

```typescript
const client = new XTwitterScraper();
// Reads X_TWITTER_SCRAPER_API_KEY from env
```

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

### GET /support/tickets

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-support.md

Lists all tickets for the authenticated user.

```APIDOC
## GET /support/tickets

### Description
Returns all tickets for the authenticated user.

### Method
GET

### Endpoint
/support/tickets
```

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

### Manage API Credentials via Environment Variables

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

Demonstrates the secure practice of using environment variables instead of hardcoding API keys.

```typescript
// ✗ Don't do this
const client = new XTwitterScraper({
  apiKey: 'sk_...',  // Exposed!
});

// ✓ Do this
const client = new XTwitterScraper({
  apiKey: process.env.X_TWITTER_SCRAPER_API_KEY,
});
```

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

### GET /monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-monitors.md

Retrieves a list of all active monitors.

```APIDOC
## GET /monitors

### Description
Returns all monitors (up to 200, no pagination).

### Method
GET

### Endpoint
/monitors

### Response
- **monitors** (array) - List of monitor objects
- **total** (number) - Total count of monitors
```

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

### POST /credits/topup

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

Initiates a credit topup.

```APIDOC
## POST /credits/topup

### Description
Initiates a credit topup.

### Method
POST

### Endpoint
/credits/topup

### Response
#### Success Response (200)
- **CreditTopupBalanceResponse** (object) - The response object containing topup details.
```

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

### Configure Headers via Environment Variables

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

Set custom headers using newline-separated key:value pairs in the environment.

```bash
export X_TWITTER_SCRAPER_CUSTOM_HEADERS="X-Custom-Header: value
X-Another-Header: another-value"
```

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

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

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

Downloads a support attachment by its ID.

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

### Description
Downloads a support attachment by its ID.

### Method
GET

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

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

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

### GET /draws/{id}

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

Retrieves details for a specific draw.

```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.
```

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

### Verify environment variables

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

Check that the required API key, base URL, and log settings are correctly set in the shell environment.

```bash
echo $X_TWITTER_SCRAPER_API_KEY
echo $X_TWITTER_SCRAPER_BASE_URL
echo $X_TWITTER_SCRAPER_LOG
```

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

### GET /styles/{id}

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

Retrieves a style profile by its ID.

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

### Description
Retrieves a style profile by its ID.

### Method
GET

### Endpoint
/styles/{id}

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

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

### GET /drafts/{id}

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

Retrieves a specific draft by its ID.

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

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

### Method
GET

### Endpoint
/drafts/{id}

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

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

### POST /compose

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

Creates a new composition.

```APIDOC
## POST /compose

### Description
Creates a new composition.

### Method
POST

### Endpoint
/compose
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Check status of a write action.

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

### Description
Check a pending write action by the ID returned from an earlier write response.

### Method
GET

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

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

### GET /x/tweets/search

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-api.md

Search tweets using X syntax.

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

### Description
Search using X syntax: keywords, #hashtags, from:user, to:user, "exact phrases", OR, -exclude.

### Method
GET

### Endpoint
/x/tweets/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string.
```

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

### Set fetch options

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

Provide RequestInit options to the client or specific requests to customize fetch behavior.

```ts
import XTwitterScraper from 'x-twitter-scraper';

const client = new XTwitterScraper({
  fetchOptions: {
    // `RequestInit` options
  },
});
```

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

### Get Notifications Endpoint

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-api.md

Retrieves notifications for the authenticated account.

```http
GET /x/notifications
```

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

### POST /x/media

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Upload media to X.

```APIDOC
## POST /x/media

### Description
Upload media to X. Returns mediaId and mediaUrl.

### Method
POST

### Endpoint
/x/media

### Request Body
- **account** (string) - Required - Connected X username or account ID
- **file** (file) - Optional - Media file
- **url** (string) - Optional - Direct media URL
- **is_long_video** (boolean) - Optional - Flag for long video
```

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

### GET /x/accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-accounts.md

Retrieves a list of all connected X accounts.

```APIDOC
## GET /x/accounts

### Description
Returns all connected X accounts.

### Method
GET

### Endpoint
/x/accounts

### Response
#### Success Response (200)
- **accounts** (array) - List of account objects containing id, username, displayName, isActive, and createdAt.
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-support.md

Retrieves a specific ticket by its ID.

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

### Description
Returns a specific ticket including its messages.

### Method
GET

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

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

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

### Configure Cursor MCP Server

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Add this configuration to your Cursor MCP settings file to enable the xquik server.

```json
{
  "mcpServers": {
    "xquik": {
      "url": "https://xquik.com/mcp"
    }
  }
}
```

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

### GET /extractions

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-extractions.md

List extraction jobs with cursor-based pagination.

```APIDOC
## GET /extractions

### Description
List extraction jobs. Cursor-paginated. Filter by status and toolType.

### Method
GET

### Endpoint
/extractions
```

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

### Enable debug logging

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

Initialize the client with the logLevel set to 'debug' to output full request and response details.

```typescript
const client = new XTwitterScraper({
  logLevel: 'debug',
});
// Now all requests/responses are logged with full details
```

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

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

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

Retrieves tweets from a specific list.

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

### Description
Retrieves a paginated list of tweets contained within the specified list.

### Method
GET

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

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

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

### Inspect current client configuration

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

Access the client instance properties to verify the current base URL, timeout, retry settings, and log level.

```typescript
const client = new XTwitterScraper();
console.log('Base URL:', client.baseURL);
console.log('Timeout:', client.timeout);
console.log('Max Retries:', client.maxRetries);
console.log('Log Level:', client.logLevel);
```

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

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

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

Retrieves members of a specific list.

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

### Description
Retrieves a paginated list of members belonging to the specified list.

### Method
GET

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

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

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

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

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

Retrieves followers of a specific list.

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

### Description
Retrieves a paginated list of users who follow the specified list.

### Method
GET

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

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

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

### SDK Initialization

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

How to initialize the XTwitterScraper client using an API key or bearer token.

```APIDOC
## SDK Initialization

### Description
Initialize the client using either an API key or a bearer token for authentication.

### Usage
```typescript
// Option 1: API Key
const client = new XTwitterScraper({
  apiKey: process.env.X_TWITTER_SCRAPER_API_KEY,
});

// Option 2: Bearer Token
const client = new XTwitterScraper({
  bearerToken: process.env.X_TWITTER_SCRAPER_BEARER_TOKEN,
});
```
```

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

### Create Client with Merged Options

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

Generate a new client instance that inherits existing settings while overriding specific parameters.

```typescript
const client = new XTwitterScraper({ apiKey: 'key1' });
const client2 = client.withOptions({ timeout: 30000 });
// client2 has apiKey from client plus new timeout
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/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

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

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

### Configure Windsurf MCP Server

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Add this configuration to the Windsurf MCP configuration file.

```json
{
  "mcpServers": {
    "xquik": {
      "serverUrl": "https://xquik.com/mcp"
    }
  }
}
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/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

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

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

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

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

Retrieves details for a specific keyword by ID.

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

### Description
Retrieves details for a specific keyword by ID.

### Method
GET

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

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

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

### Export SDK modules from index

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

The main entry point exports the primary client, utility functions, and error classes.

```typescript
export { XTwitterScraper as default } from './client';
export { type Uploadable, toFile } from './core/uploads';
export { APIPromise } from './core/api-promise';
export { XTwitterScraper, type ClientOptions } from './client';
export {
  XTwitterScraperError,
  APIError,
  APIConnectionError,
  APIConnectionTimeoutError,
  APIUserAbortError,
  NotFoundError,
  ConflictError,
  RateLimitError,
  BadRequestError,
  AuthenticationError,
  InternalServerError,
  PermissionDeniedError,
  UnprocessableEntityError,
} from './core/error';
```

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

### POST /x/users/{id}/follow

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Follow a user.

```APIDOC
## POST /x/users/{id}/follow

### Description
Follow a user.

### Method
POST

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

### Request Body
- **account** (string) - Required - Connected X username or account ID
```

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

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

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/workflows.md

Retrieves a single tweet by its ID or URL.

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

### Description
Retrieves details for a single tweet.

### Method
GET

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

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

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

### GET /api/v1/x/followers/check

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/types-x-api.md

Checks the follow relationship between two users on X.

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

### Description
Retrieves the follow relationship status between a source user and a target user.

### Method
GET

### Endpoint
/api/v1/x/followers/check

### Query Parameters
- **sourceUsername** (string) - Required - The username of the source account.
- **targetUsername** (string) - Required - The username of the target account.

### Response
#### Success Response (200)
- **sourceUsername** (string) - The username of the source account.
- **targetUsername** (string) - The username of the target account.
- **isFollowing** (boolean) - Whether the source follows the target.
- **isFollowedBy** (boolean) - Whether the target follows the source.
```

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

### Authenticate with Xquik API

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/python-examples.md

Sets up the required headers and API key retrieval for authenticated requests.

```python
import json
import urllib.error
import urllib.request

def load_secret(name: str) -> str:
    """Read from your agent or platform secret store."""
    raise RuntimeError(f"Configure {name} in your secret store.")

API_KEY = load_secret("XQUIK_API_KEY")
BASE = "https://xquik.com/api/v1"
HEADERS = {"x-api-key": API_KEY, "Content-Type": "application/json"}
```

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

### withOptions(options: Partial<ClientOptions>): XTwitterScraper

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

Creates a new client instance with merged options, preserving current settings.

```APIDOC
## withOptions(options: Partial<ClientOptions>)

### Description
Creates a new client instance with merged options, preserving current settings.

### Parameters
- **options** (Partial<ClientOptions>) - Required - Partial options to override or extend
```

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

### GET /x/tweets/search

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

Search for tweets using a keyword with cursor-based pagination.

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

### Description
Search for tweets based on a keyword. Supports cursor-based pagination to retrieve large result sets.

### Method
GET

### Endpoint
/x/tweets/search

### Query Parameters
- **q** (string) - Required - The search keyword.
- **cursor** (string) - Optional - The cursor for the next page of results.
- **limit** (number) - Optional - The maximum number of results to return.

### Response
#### Success Response (200)
- **data** (array) - List of tweet objects.
- **next_cursor** (string) - The cursor for the next page.
- **has_next_page** (boolean) - Indicates if more pages are available.

### Response Example
{
  "data": [],
  "next_cursor": "def456",
  "has_next_page": true
}
```

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

### Get DM History

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Endpoint to retrieve conversation history with a user.

```http
GET /x/dm/{userId}/history
```

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

### POST /x/communities/{id}/join

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-write.md

Join a community.

```APIDOC
## POST /x/communities/{id}/join

### Description
Join a community.

### Method
POST

### Endpoint
/x/communities/{id}/join

### Request Body
- **account** (string) - Required - Connected X username or account ID
```

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

### Get Bookmarks Endpoint

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-api.md

Retrieves bookmarked tweets for the authenticated account.

```http
GET /x/bookmarks
```

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

### Get Mutual Followers Endpoint

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-x-api.md

Retrieves mutual followers for a user.

```http
GET /x/users/{id}/followers-you-know
```

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

### client.extractions.run

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

Initiates a data extraction job for a specific tool and target.

```APIDOC
## client.extractions.run(params)

### Description
Starts an extraction job.

### Parameters
- **toolType** (string) - Required - The type of extraction tool.
- **targetUsername** (string) - Required - The target username for extraction.
```

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

### CreateMonitorRequest

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/types-request-bodies.md

Interface for creating a new monitor.

```APIDOC
## CreateMonitorRequest

### Request Body
- **username** (string) - Required - The Twitter username to monitor.
- **eventTypes** (EventType[]) - Required - List of event types to track.
```

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

### GET /monitors/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-monitors.md

Retrieves details for a specific monitor by its ID.

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

### Description
Retrieves details for a specific monitor.

### Method
GET

### Endpoint
/monitors/{id}

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

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

### Get Monitor Endpoint

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-monitors.md

Retrieves details for a specific monitor by its ID.

```http
GET /monitors/{id}
```

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

### Use a custom logger

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

Integrates a custom logger instance, such as pino, to handle SDK log output.

```ts
import XTwitterScraper from 'x-twitter-scraper';
import pino from 'pino';

const logger = pino();

const client = new XTwitterScraper({
  logger: logger.child({ name: 'XTwitterScraper' }),
  logLevel: 'debug', // Send all messages to pino, allowing it to filter
});
```

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

### GET /events/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-events.md

Retrieves a single event by its unique identifier.

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

### Description
Returns a single event with full details.

### Method
GET

### Endpoint
/events/{id}

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

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

### Configure Gemini CLI MCP

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/mcp-setup.md

Add the remote server via CLI command or by editing the settings file.

```bash
gemini mcp add --transport http xquik https://xquik.com/mcp
```

```json
{
  "mcpServers": {
    "xquik": {
      "type": "http",
      "url": "https://xquik.com/mcp"
    }
  }
}
```

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

### GET /events

Source: https://github.com/xquik-dev/x-twitter-scraper-typescript/blob/main/skills/x-twitter-scraper/references/api-endpoints-events.md

Retrieves a list of events based on optional filters.

```APIDOC
## GET /events

### Description
Retrieves a list of events. Supports filtering by monitor ID, event type, and pagination.

### Method
GET

### Endpoint
/events

### Parameters
#### Query Parameters
- **monitorId** (string) - Optional - Filter by monitor ID
- **eventType** (string) - Optional - Filter by event type
- **limit** (number) - Optional - Results per page (1-100, default 50)
- **after** (string) - Optional - Cursor for next page

### Response
#### Success Response (200)
- **events** (array) - List of event objects
- **hasMore** (boolean) - Indicates if more pages are available
- **nextCursor** (string) - Cursor for the next page of results

#### Response Example
{
  "events": [
    {
      "id": "9010",
      "type": "tweet.new",
      "monitorId": "7",
      "username": "elonmusk",
      "occurredAt": "2026-02-24T16:45:00.000Z",
      "data": {
        "tweetId": "1893556789012345678",
        "text": "Hello world",
        "metrics": { "likes": 3200, "retweets": 890, "replies": 245 }
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "MjAyNi0wMi0yNFQxNjozMDowMC4wMDBa..."
}
```
Tokens:
Raw