X Twitter Scraper

https://github.com/xquik-dev/x-twitter-scraper-php
Admin
A PHP SDK library providing convenient access to the X Twitter Scraper REST API for searching...
Tokens:35,751
Snippets:457
Trust Score:5.5
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Webhooks

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

Register a webhook URL for specific events and prepare for signature verification.

```php
$webhook = $client->webhooks->create(
    url: 'https://example.com/webhook',
    events: ['tweet.created', 'user.followed']
);

// Verify incoming webhook requests
$secret = $webhook->secret;
$signature = $_SERVER['HTTP_X_SIGNATURE'];
// Use $secret to verify HMAC-SHA256 of request body
```

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

### Execute follow action

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Example usage of the create method to follow a specific user.

```php
$response = $client->x->users->follow->create(
    sourceAccount: '@myaccount',
    targetUserID: 'elonmusk'
);
```

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

### Create a new webhook example

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Demonstrates how to create a webhook and access the returned ID and secret for verification.

```php
$webhook = $client->webhooks->create(
    url: 'https://example.com/webhook',
    events: ['tweet.created', 'user.followed']
);

echo $webhook->id;
echo $webhook->secret;  // For request verification
```

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

### Install the package via Composer

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

Use Composer to add the library to your project dependencies.

```sh
composer require xquik/x-twitter-scraper:^0.10.0
```

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

### Setup and Manage Webhooks

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Configure webhooks to receive event notifications and verify them using the provided secret.

```php
<?php

// Create webhook
$webhook = $client->webhooks->create(
    url: 'https://example.com/webhook',
    events: ['tweet.created', 'user.followed']
);

echo $webhook->secret;  // Use to verify incoming webhooks

// Test webhook
$response = $client->webhooks->test($webhook->id);

// List webhooks
$webhooks = $client->webhooks->list();

// Delete webhook
$client->webhooks->delete($webhook->id);
```

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

### Like a tweet example

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Demonstrates how to like a specific tweet using the LikeService.

```php
$response = $client->x->tweets->like->create(
    account: '@myaccount',
    tweetID: '1234567890'
);
```

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

### retrieve()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Gets webhook details.

```APIDOC
## retrieve()

### Description
Gets webhook details.

### Parameters
- **id** (string) - Required - The ID of the webhook to retrieve.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **WebhookDetail** - The webhook details.
```

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

### MonitorsService::retrieve

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Gets monitor details and results by ID.

```APIDOC
## MonitorsService::retrieve

### Description
Gets monitor details and results.

### Parameters
- **id** (string) - Required - The monitor ID
- **requestOptions** (RequestOptions|array) - Optional - Additional request configuration

### Returns
- **MonitorDetail** - Monitor with current matches
```

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

### Retweet a tweet example

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Demonstrates how to retweet a specific tweet using the RetweetService.

```php
$response = $client->x->tweets->retweet->create(
    account: '@myaccount',
    tweetID: '1234567890'
);
```

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

### Create a custom writing style

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Defines a new custom writing style with a name, description, and optional examples.

```php
public function create(
    string $name,
    string $description,
    ?array $examples = null,
    RequestOptions|array|null $requestOptions = null,
): StyleDetail
```

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

### Bootstrap development environment

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

Install locked development dependencies after ensuring PHP 8.3+ and Composer 2.10.2 are present.

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

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

### retrieve(string $id, RequestOptions|array|null $requestOptions)

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Gets a draft by ID.

```APIDOC
## retrieve(string $id, RequestOptions|array|null $requestOptions)

### Description
Gets a draft by ID.

### Parameters
- **id** (string) - Required - Resource ID (stringified bigint)
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration

### Returns
- **DraftDetail** - The requested draft
```

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

### Basic Client Initialization

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

Demonstrates various ways to instantiate the client, including using API keys, environment variables, custom base URLs, and request options.

```php
<?php

use XTwitterScraper\Client;

// Initialize with API key
$client = new Client(
    apiKey: 'your-api-key-here'
);

// Or use environment variables
$client = new Client();

// Initialize with custom base URL
$client = new Client(
    apiKey: 'your-api-key',
    baseUrl: 'https://custom-api.example.com/v1'
);

// Initialize with request options
$client = new Client(
    apiKey: 'your-api-key',
    requestOptions: [
        'timeout' => 30,
        'maxRetries' => 5
    ]
);
```

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

### Client::__construct

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

Initializes a new Client instance with authentication credentials and configuration options.

```APIDOC
## Constructor

### Description
Initializes a new Client instance. Credentials can be passed directly or read from environment variables.

### Signature
`public function __construct(?string $apiKey = null, ?string $bearerToken = null, ?string $baseUrl = null, RequestOptions|array|null $requestOptions = null): void`

### Parameters
- **apiKey** (?string) - Optional - API key for authentication. Defaults to X_TWITTER_SCRAPER_API_KEY env var.
- **bearerToken** (?string) - Optional - Bearer token for OAuth. Defaults to X_TWITTER_SCRAPER_BEARER_TOKEN env var.
- **baseUrl** (?string) - Optional - Base URL for API requests. Defaults to https://xquik.com/api/v1.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options including timeout and retries.
```

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

### EventsService::retrieve

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Gets event details by ID.

```APIDOC
## EventsService::retrieve

### Description
Gets event details.

### Parameters
- **id** (string) - Required - The event ID
- **requestOptions** (RequestOptions|array) - Optional - Additional request configuration

### Returns
- **EventDetail** - The event details
```

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

### Initialize the Client

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Configure the client using API keys, bearer tokens, or environment variables.

```php
<?php

use XTwitterScraper\Client;

// Using API key from environment variable
$client = new Client();

// Or provide API key explicitly
$client = new Client(apiKey: 'your-api-key-here');

// With bearer token (OAuth)
$client = new Client(bearerToken: 'your-bearer-token');

// With both authentication methods
$client = new Client(
    apiKey: 'your-api-key',
    bearerToken: 'your-bearer-token'
);
```

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

### Create Monitor

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Initializes a new keyword or mention monitor.

```php
public function create(
    string $keywords,
    ?string $name = null,
    RequestOptions|array|null $requestOptions = null,
): MonitorDetail
```

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

### retrieve()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Gets a specific extraction job by its unique ID.

```APIDOC
## retrieve(id, requestOptions)

### Description
Gets a specific extraction job by ID.

### Parameters
- **id** (string) - Required - The unique identifier of the extraction job.

### Returns
- **ExtractionGetResponse** - Job status and results.

### Throws
- **APIException**
```

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

### Construct models using static and builder patterns

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

Demonstrates the two supported patterns for initializing model instances.

```php
$tweet = SearchTweet::with(
    id: '1234567890',
    text: 'Hello'
);
```

```php
$tweet = (new SearchTweet())
    ->withId('1234567890')
    ->withText('Hello')
    ->withLikeCount(100);
```

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

### Get Followers

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Retrieve a list of followers for a user, supporting pagination.

```php
<?php

// Get follower list
$followers = $client->x->users->retrieveFollowers(
    id: 'elonmusk',
    pageSize: 100
);

foreach ($followers->users as $follower) {
    echo $follower->username . "\n";
}

// Paginate through followers
$cursor = null;
do {
    $page = $client->x->users->retrieveFollowers(
        id: 'elonmusk',
        pageSize: 200,
        cursor: $cursor
    );
    
    foreach ($page->users as $user) {
        // Process user
    }
    
    $cursor = $page->hasNextPage ? $page->nextCursor : null;
} while ($cursor !== null);
```

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

### Get User Profile

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Retrieve public profile information for a specific username.

```php
<?php

// Get profile by username
$user = $client->x->users->retrieve('elonmusk');

echo $user->name;           // Display name
echo $user->username;       // Username
echo $user->followers;      // Follower count
echo $user->verified;       // Verification status
echo $user->description;    // Bio
```

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

### Initialize RequestOptions with named parameters

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/request-options.md

Use the static with() method to create a configured instance using named arguments.

```php
$options = RequestOptions::with(
    timeout: 30,
    maxRetries: 5,
    extraHeaders: ['X-Custom-Header' => 'value']
);
```

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

### Get tweets from a list

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Retrieves a paginated collection of tweets associated with a specific list.

```php
public function getTweets(
    string $id,
    ?string $cursor = null,
    ?int $limit = null,
    RequestOptions|array|null $requestOptions = null,
): PaginatedTweets
```

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

### Initialize Client Authentication

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

Configure the client using API keys, bearer tokens, or environment variables.

```php
use XTwitterScraper\Client;

// API Key
$client = new Client(apiKey: 'your-api-key');

// Bearer Token
$client = new Client(bearerToken: 'your-token');

// Both
$client = new Client(
    apiKey: 'your-api-key',
    bearerToken: 'your-token'
);

// Environment variables (automatic)
$client = new Client();
// Reads: X_TWITTER_SCRAPER_API_KEY, X_TWITTER_SCRAPER_BEARER_TOKEN
```

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

### Configure Global Client Settings in PHP

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Initialize the client with default request options that apply to all subsequent calls.

```php
<?php

use XTwitterScraper\Client;
use XTwitterScraper\RequestOptions;

$client = new Client(
    apiKey: 'your-api-key',
    requestOptions: RequestOptions::with(
        timeout: 30,
        maxRetries: 5,
        extraHeaders: ['X-Custom' => 'value']
    )
);
```

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

### list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists all configured webhooks.

```APIDOC
## list()

### Description
Lists all configured webhooks.

### Parameters
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **WebhookListResponse** - A list of configured webhooks.
```

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

### create(string $sourceAccount, string $targetUserID, RequestOptions|array|null $requestOptions = null)

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Follows a user on X.

```APIDOC
## create(string $sourceAccount, string $targetUserID, RequestOptions|array|null $requestOptions = null)

### Description
Follows a user.

### Parameters
- **sourceAccount** (string) - Required - X account doing the following
- **targetUserID** (string) - Required - User ID to follow

### Returns
- **FollowCreateResponse** - Confirmation

### Throws
- **APIException**
```

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

### Initialize client and search tweets

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

Instantiate the client using an API key and perform a search query using named parameters.

```php
<?php

use XTwitterScraper\Client;

$client = new Client(
  apiKey: getenv('X_TWITTER_SCRAPER_API_KEY') ?: 'My API Key'
);

$paginatedTweets = $client->x->tweets->search(q: 'from:elonmusk', limit: 10);

var_dump($paginatedTweets->hasNextPage);
```

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

### create()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new API key with a specified name and optional permissions.

```APIDOC
## create()

### Description
Creates a new API key for the account.

### Method
PHP Method

### Signature
`public function create(string $name, ?array $permissions = null, RequestOptions|array|null $requestOptions = null): APIKeyNewResponse`

### Parameters
#### Required Parameters
- **name** (string) - Required - The label or name for the new API key.

#### Optional Parameters
- **permissions** (?array) - Optional - The permissions to grant to the new key.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **APIKeyNewResponse** - The newly created API key including the secret.
```

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

### Configure Environment Variables

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

Set the required API credentials and base URL in your environment configuration.

```bash
X_TWITTER_SCRAPER_API_KEY="your-api-key"
X_TWITTER_SCRAPER_BEARER_TOKEN="your-token"
X_TWITTER_SCRAPER_BASE_URL="https://xquik.com/api/v1"
```

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

### MonitorsService::create

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new keyword or mention monitor.

```APIDOC
## MonitorsService::create

### Description
Creates a new keyword or mention monitor.

### Parameters
- **keywords** (string) - Required - Keywords to monitor (comma-separated)
- **name** (string) - Optional - Monitor name
- **requestOptions** (RequestOptions|array) - Optional - Additional request configuration

### Returns
- **MonitorDetail** - The created monitor object
```

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

### StylesService::list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists all available writing styles for AI composition.

```APIDOC
## StylesService::list()

### Description
Lists available writing styles.

### Parameters
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **StyleListResponse** - The list of available writing styles.

### Throws
- **APIException**
```

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

### ListsService::create

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Creates a new user list.

```APIDOC
## ListsService::create

### Description
Creates a new list.

### Parameters
- **name** (string) - Required - List name
- **description** (string) - Optional - List description
- **isPrivate** (bool) - Optional - Make list private
- **requestOptions** (RequestOptions|array) - Optional - Request configuration

### Returns
- **ListDetail** - Created list
```

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

### Configure Environment Variables

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Set these variables to allow the client to automatically authenticate and connect to the API.

```bash
export X_TWITTER_SCRAPER_API_KEY="your-api-key"
export X_TWITTER_SCRAPER_BEARER_TOKEN="your-bearer-token"
export X_TWITTER_SCRAPER_BASE_URL="https://xquik.com/api/v1"
```

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

### Client Initialization

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

How to instantiate the XTwitterScraper client using API keys, Bearer tokens, or environment variables.

```APIDOC
## Client Initialization

### Description
Initialize the `XTwitterScraper\Client` to interact with the API. Authentication can be handled via API Key, Bearer Token, or environment variables.

### Usage
```php
use XTwitterScraper\Client;

// API Key
$client = new Client(apiKey: 'your-api-key');

// Bearer Token
$client = new Client(bearerToken: 'your-token');

// Environment variables (automatic)
// Reads: X_TWITTER_SCRAPER_API_KEY, X_TWITTER_SCRAPER_BEARER_TOKEN
$client = new Client();
```
```

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

### Configure Client Request Options

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

Define global client settings or override them on a per-request basis.

```php
use XTwitterScraper\RequestOptions;

$client = new Client(
    apiKey: 'key',
    baseUrl: 'https://custom-api.example.com/v1',
    requestOptions: RequestOptions::with(
        timeout: 30,
        maxRetries: 5,
        extraHeaders: ['X-Custom' => 'value']
    )
);
```

```php
$tweets = $client->x->tweets->search(
    q: 'PHP',
    requestOptions: [
        'timeout' => 10,
        'maxRetries' => 0
    ]
);
```

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

### Define FollowService create method signature

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Method signature for initiating a follow action on X.

```php
public function create(
    string $sourceAccount,
    string $targetUserID,
    RequestOptions|array|null $requestOptions = null
): FollowCreateResponse
```

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

### Set global client configuration

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/request-options.md

Define default request options during client instantiation to apply them to all subsequent requests.

```php
$client = new Client(
    apiKey: 'your-api-key',
    requestOptions: [
        'timeout' => 30,
        'maxRetries' => 5,
        'extraHeaders' => ['X-Custom-Header' => 'value']
    ]
);
```

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

### Client Constructor Signature

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

Defines the constructor parameters for initializing the client with authentication and configuration.

```php
public function __construct(
    ?string $apiKey = null,
    ?string $bearerToken = null,
    ?string $baseUrl = null,
    RequestOptions|array|null $requestOptions = null,
): void
```

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

### $client->x->media->upload()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Uploads media files to be used in tweets.

```APIDOC
## $client->x->media->upload()

### Description
Uploads a file or resource to Xquik for use in tweets.

### Parameters
- **account** (string) - Required - The account handle.
- **file** (mixed) - Required - The file content or FileParam object.
```

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

### Create a new list

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Creates a new list with a specified name, optional description, and privacy setting.

```php
public function create(
    string $name,
    ?string $description = null,
    ?bool $isPrivate = null,
    RequestOptions|array|null $requestOptions = null,
): ListDetail
```

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

### Construct models using static with() method

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

Use the static with() method for concise instantiation of model classes with required parameters.

```php
$tweet = SearchTweet::with(id: '123', text: 'Hello');
$profile = UserProfile::with(id: '456', name: 'John', username: 'john');
```

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

### StylesService::create()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new custom writing style.

```APIDOC
## StylesService::create()

### Description
Creates a custom writing style.

### Parameters
- **name** (string) - Required - The name of the style.
- **description** (string) - Required - A description of the style.
- **examples** (array|null) - Optional - Examples for the style.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **StyleDetail** - The created style details.

### Throws
- **APIException**
```

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

### Uploading Files with FileParam

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

Demonstrates uploading files using FileParam from strings, resources, or direct string content.

```php
use XTwitterScraper\Core\FileParam;

// From string
$response = $client->x->media->upload(
    account: '@myaccount',
    file: FileParam::fromString(
        file_get_contents('image.jpg'),
        filename: 'image.jpg',
        contentType: 'image/jpeg'
    )
);

// From resource
$fd = fopen('image.jpg', 'r');
$response = $client->x->media->upload(
    account: '@myaccount',
    file: FileParam::fromResource($fd, 'image.jpg', 'image/jpeg')
);
fclose($fd);

// Direct string (inferred as file content)
$response = $client->x->media->upload(
    account: '@myaccount',
    file: 'image content as string'
);
```

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

### create()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new webhook endpoint.

```APIDOC
## create()

### Description
Creates a new webhook endpoint.

### Parameters
- **url** (string) - Required - Webhook URL to receive POST requests.
- **events** (?array) - Optional - Events to subscribe to.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **WebhookDetail** - The created webhook details.
```

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

### Verify release archive

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

Use GitHub CLI to download and verify the integrity of the project archive before upgrading.

```sh
release_tag=vVERSION
archive="x-twitter-scraper-php-$release_tag.zip"

gh release download "$release_tag" \
  --repo Xquik-dev/x-twitter-scraper-php \
  --pattern "$archive"

gh attestation verify "$archive" \
  --repo Xquik-dev/x-twitter-scraper-php \
  --signer-workflow Xquik-dev/x-twitter-scraper-php/.github/workflows/release-provenance.yml \
  --source-ref "refs/tags/$release_tag" \
  --deny-self-hosted-runners
```

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

### Monitor Keywords

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

Create a keyword monitor and retrieve matches later.

```php
$monitor = $client->monitors->create(
    keywords: 'PHP,Laravel',
    name: 'Framework Monitor'
);

// Later...
$results = $client->monitors->retrieve($monitor->id);
foreach ($results->matches as $match) {
    // Process matched tweets
}
```

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

### Run verification gates

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

Execute the full suite of linting, testing, coverage, and security checks before requesting a review.

```sh
./scripts/lint
./scripts/test
./scripts/coverage
./scripts/audit
reuse lint
./scripts/check-reproducible
```

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

### Accessing API Services

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

Shows how to interact with the XService through the client instance to perform actions like searching tweets, retrieving profiles, and uploading media.

```php
<?php

// Tweet search
$tweets = $client->x->tweets->search(q: 'PHP');

// Get user profile
$user = $client->x->users->retrieve(id: 'elonmusk');

// Create a tweet
$tweet = $client->x->tweets->create(
    account: '@myaccount',
    text: 'Hello, world!'
);

// Upload media
$media = $client->x->media->upload(
    account: '@myaccount',
    file: 'image.jpg'
);
```

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

### Create an API key

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new API key with a specified name and optional permissions.

```php
public function create(
    string $name,
    ?array $permissions = null,
    RequestOptions|array|null $requestOptions = null,
): APIKeyNewResponse
```

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

### Construct SearchTweet instances

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

Demonstrates static factory and builder pattern approaches for creating SearchTweet objects.

```php
// Static constructor with required parameters
$tweet = SearchTweet::with(
    id: '1234567890',
    text: 'Hello, world!'
);

// Builder pattern
$tweet = (new SearchTweet())
    ->withId('1234567890')
    ->withText('Hello, world!')
    ->withLikeCount(100);
```

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

### List subscription plans via SubscribeService

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves a list of all available subscription plans.

```php
public function list(
    RequestOptions|array|null $requestOptions = null
): SubscriptionListResponse
```

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

### Construct models using the builder pattern

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

Use the builder pattern for fluent, step-by-step configuration of model properties.

```php
$tweet = (new SearchTweet())
    ->withId('123')
    ->withText('Hello')
    ->withLikeCount(100);
```

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

### CommunitiesService::join->create

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Joins a specific community.

```APIDOC
## join->create(string $communityID, RequestOptions|array|null $requestOptions = null)

### Description
Joins a community.

### Parameters
- **communityID** (string) - Required - Community ID
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration

### Returns
- **CommunityJoinResponse**

### Throws
- **APIException**
```

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

### Perform Bulk User Operations

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

Retrieve followers and perform follow actions for each user.

```php
// Get followers
$followers = $client->x->users->retrieveFollowers(
    id: 'myaccount',
    pageSize: 200
);

// Follow them back
foreach ($followers->users as $follower) {
    $client->x->users->follow->create(
        sourceAccount: '@myaccount',
        targetUserID: $follower->id
    );
}
```

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

### List writing styles with StylesService

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves a list of available writing styles. Throws an APIException on failure.

```php
public function list(
    RequestOptions|array|null $requestOptions = null
): StyleListResponse
```

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

### Create support ticket via SupportService

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new support ticket with a subject, description, and optional category.

```php
public function tickets()->create(
    string $subject,
    string $description,
    ?string $category = null,
    RequestOptions|array|null $requestOptions = null,
): TicketDetail
```

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

### Access model properties via array interface

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

Demonstrates how to interact with model properties using array syntax.

```php
$tweet['id'];     // Get property
$tweet['text'] = 'New text';  // Set property
isset($tweet['text']);  // Check if set
unset($tweet['text']);  // Unset property
```

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

### run()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Executes a draw to select winners.

```APIDOC
## run()

### Description
Runs a draw to select winners.

### Parameters
- **id** (string) - Required - Draw ID
- **winnerCount** (int) - Optional - Number of winners to select
- **requestOptions** (RequestOptions|array) - Optional - Request configuration

### Returns
- **DrawRunResponse** - Winners list
```

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

### Accessing X Sub-Services

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Use property chaining on the client instance to access specialized sub-service functionality.

```php
// Via property access
$client->x->tweets->like->create(...)
$client->x->tweets->retweet->create(...)
$client->x->users->follow->create(...)
$client->x->communities->tweets->list(...)
$client->x->communities->join->create(...)
```

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

### retrieve()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves current account information, including credit balance and plan details.

```APIDOC
## retrieve()

### Description
Gets current account information including credits and plan.

### Method
`public function retrieve(RequestOptions|array|null $requestOptions = null): AccountGetResponse`

### Parameters
#### Optional Parameters
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **AccountGetResponse** - Account details and credit info.

### Example
```php
$account = $client->account->retrieve();
echo $account->username;
echo $account->creditInfo->balance;
```
```

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

### SupportService::tickets()->create

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new support ticket with a subject, description, and optional category.

```APIDOC
## SupportService::tickets()->create

### Description
Creates a new support ticket.

### Method
PHP Method

### Signature
`public function tickets()->create(string $subject, string $description, ?string $category = null, RequestOptions|array|null $requestOptions = null): TicketDetail`

### Parameters
- **subject** (string) - Required - The ticket subject
- **description** (string) - Required - The ticket description
- **category** (string) - Optional - The ticket category

### Returns
- **TicketDetail** - The created ticket details.
```

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

### list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves a list of all API keys associated with the account.

```APIDOC
## list()

### Description
Lists all API keys associated with the account.

### Method
PHP Method

### Signature
`public function list(RequestOptions|array|null $requestOptions = null): APIKeyListResponse`

### Parameters
#### Optional Parameters
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **APIKeyListResponse** - A list of API keys.
```

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

### create(string $text, Goal|string|null $goal, ?string $topic, RequestOptions|array|null $requestOptions)

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Creates a new tweet draft with optional AI assistance goal.

```APIDOC
## create(string $text, Goal|string|null $goal, ?string $topic, RequestOptions|array|null $requestOptions)

### Description
Creates a new tweet draft with optional AI assistance goal.

### Parameters
- **text** (string) - Required - Draft text content
- **goal** (Goal|string|null) - Optional - AI goal: 'Engagement', 'Clarity', 'Professionalism'
- **topic** (?string) - Optional - Topic for AI context
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration

### Returns
- **DraftDetail** - Created draft

### Example
```php
$draft = $client->drafts->create(
    text: 'Check out this new feature!',
    goal: 'Engagement',
    topic: 'Product announcement'
);
```
```

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

### SubscribeService::list

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists all available subscription plans.

```APIDOC
## SubscribeService::list

### Description
Lists available subscription plans.

### Method
PHP Method

### Signature
`public function list(RequestOptions|array|null $requestOptions = null): SubscriptionListResponse`

### Returns
- **SubscriptionListResponse** - The list of subscription plans.
```

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

### UsersService Methods

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

Methods for retrieving user profiles and follower lists.

```APIDOC
## UsersService Methods

- `retrieve(id, requestOptions?): UserProfile`
- `retrieveBatch(ids, requestOptions?): PaginatedUsers`
- `retrieveFollowers(id, cursor?, pageSize?, requestOptions?): PaginatedUsers`
```

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

### List Monitors

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves active monitors with optional pagination support.

```php
public function list(
    ?string $afterCursor = null,
    int $limit = 50,
    RequestOptions|array|null $requestOptions = null,
): MonitorListResponse
```

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

### Define AccountGetResponse model

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

Represents account information including credits and plan details.

```php
final class AccountGetResponse implements BaseModel
{
    public string $username;
    public ?CreditInfo $creditInfo;
    public ?Plan $plan;
}
```

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

### AccountsService::list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Retrieves a list of all linked X accounts.

```APIDOC
## AccountsService::list()

### Description
Lists all linked X accounts.

### Method
public function list(RequestOptions|array|null $requestOptions = null): AccountListResponse

### Parameters
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration options.

### Returns
- **AccountListResponse** - List of accounts.

### Example
```php
$accounts = $client->x->accounts->list();
foreach ($accounts->accounts as $account) {
    echo $account->username;
    echo $account->followers;
}
```
```

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

### SDK Service Architecture

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

Visual representation of the hierarchical service structure used by the Xquik client.

```text
Client (main entry point)
├── $x (XService) → Core X platform functionality
│   ├── $tweets (TweetsService) → Tweet operations
│   │   ├── $like (LikeService)
│   │   └── $retweet (RetweetService)
│   ├── $users (UsersService) → User profiles
│   │   └── $follow (FollowService)
│   ├── $followers (FollowersService) → Follower lists
│   ├── $dm (DmService) → Direct messages
│   ├── $media (MediaService) → Media upload/download
│   ├── $profile (ProfileService) → Profile updates
│   ├── $communities (CommunitiesService) → Communities
│   ├── $accounts (AccountsService) → Multi-account
│   ├── $bookmarks (BookmarksService) → Bookmarks
│   └── $lists (ListsService) → Lists
├── $account (AccountService) → Account info
├── $apiKeys (APIKeysService) → API key management
├── $subscribe (SubscribeService) → Subscriptions
├── $compose (ComposeService) → AI composition
├── $drafts (DraftsService) → Draft management
├── $styles (StylesService) → Writing styles
├── $radar (RadarService) → Trends and mentions
├── $monitors (MonitorsService) → Keyword monitoring
├── $events (EventsService) → Event tracking
├── $extractions (ExtractionsService) → Data extraction
├── $draws (DrawsService) → Giveaway draws
├── $webhooks (WebhooksService) → Webhooks
├── $trends (TrendsService) → Trending topics
├── $support (SupportService) → Support tickets
└── $credits (CreditsService) → Credit management
```

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

### Implement Exception Handling

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

Catch specific exceptions to handle authentication, rate limits, and API errors.

```php
use XTwitterScraper\Core\Exceptions\{
    AuthenticationException,
    RateLimitException,
    NotFoundException,
    APIException
};

try {
    $result = $client->x->tweets->search(q: 'PHP');
} catch (AuthenticationException $e) {
    // Invalid credentials
} catch (RateLimitException $e) {
    // Too many requests - auto-retried
} catch (NotFoundException $e) {
    // Resource not found
} catch (APIException $e) {
    // Other API errors
}
```

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

### Pagination

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

How to handle paginated results using cursor-based navigation.

```APIDOC
## Pagination

### Description
Most list endpoints return paginated results. Use the `nextCursor` property to fetch subsequent pages.

### Usage
```php
$results = $client->x->tweets->search(q: 'PHP');

// Get next page if available
if ($results->hasNextPage) {
    $next = $client->x->tweets->search(
        q: 'PHP',
        cursor: $results->nextCursor
    );
}
```
```

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

### Handle AuthenticationException

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

Catch errors related to missing or invalid API credentials.

```php
try {
    $client = new Client(apiKey: 'invalid-key');
    $user = $client->x->users->retrieve('elonmusk');
} catch (AuthenticationException $e) {
    echo "Authentication failed: " . $e->getMessage();
    // Re-authenticate or refresh credentials
}
```

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

### $client->x->tweets->create()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Creates a new tweet, optionally including media or replying to an existing tweet.

```APIDOC
## $client->x->tweets->create()

### Description
Publishes a tweet from the specified account.

### Parameters
- **account** (string) - Required - The account handle to post from.
- **text** (string) - Required - The content of the tweet.
- **media** (array) - Optional - List of media URLs.
- **mediaIDs** (array) - Optional - List of uploaded media IDs.
- **replyToTweetID** (string) - Optional - ID of the tweet to reply to.
```

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

### Configure Custom Retry Behavior

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/request-options.md

Sets custom retry limits and delay parameters during client initialization.

```php
$client = new Client(
    apiKey: 'your-api-key',
    requestOptions: [
        'maxRetries' => 5,
        'initialRetryDelay' => 1.0,
        'maxRetryDelay' => 10.0
    ]
);
```

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

### Maintenance and Verification Commands

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

Execute these commands to validate code quality, test coverage, security, and release provenance before performing a project release.

```sh
./scripts/lint
./scripts/test
./scripts/coverage
./scripts/audit
reuse lint
./scripts/check-reproducible
gh attestation verify ARCHIVE \
  --repo Xquik-dev/x-twitter-scraper-php \
  --signer-workflow Xquik-dev/x-twitter-scraper-php/.github/workflows/release-provenance.yml
```

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

### Upload Media via MediaService

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

Uploads images or videos to X. Requires a FileParam object for the file input.

```php
public function upload(
    string $account,
    string|FileParam $file,
    ?bool $isLongVideo = null,
    RequestOptions|array|null $requestOptions = null,
): MediaUploadResponse
```

```php
use XTwitterScraper\Core\FileParam;

$response = $client->x->media->upload(
    account: '@myaccount',
    file: FileParam::fromString(
        file_get_contents('image.jpg'),
        filename: 'image.jpg',
        contentType: 'image/jpeg'
    )
);

echo $response->mediaID;
```

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

### Retrieve account information

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Fetches current account details, including credit balance and plan information.

```php
public function retrieve(
    RequestOptions|array|null $requestOptions = null
): AccountGetResponse
```

```php
$account = $client->account->retrieve();
echo $account->username;
echo $account->creditInfo->balance;
```

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

### $client->x->users->retrieveFollowers()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Retrieves a list of followers for a given user ID.

```APIDOC
## $client->x->users->retrieveFollowers()

### Description
Fetches a paginated list of followers for a specific user.

### Parameters
- **id** (string) - Required - The user ID.
- **pageSize** (int) - Optional - Number of results per page.
- **cursor** (string) - Optional - Pagination cursor.
```

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

### retrieve(string $id, RequestOptions|array|null $requestOptions)

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

Retrieves a user profile with follower counts and verification status.

```APIDOC
## retrieve(string $id, RequestOptions|array|null $requestOptions)

### Description
Retrieves a user profile with follower counts and verification status.

### Parameters
- **id** (string) - Required - X username (without @) or user ID
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration

### Returns
- **UserProfile** - User profile with bio and stats

### Throws
- **APIException**
```

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

### Monitor Keywords

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

Create and retrieve keyword monitors.

```APIDOC
## $client->monitors->create(keywords, name)

### Description
Creates a new monitor for specific keywords.

## $client->monitors->retrieve(id)

### Description
Retrieves the results for a specific monitor by ID.
```

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

### Retrieve account balance with CreditsService

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Fetches current credit balance and total usage statistics from the API.

```php
$credits = $client->credits->getBalance();
echo $credits->balance;
echo $credits->totalSpent;
```

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

### CreditsService::topupBalance()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Adds a specified amount of credits to the account using an optional payment method.

```APIDOC
## topupBalance()

### Description
Adds credits to the account.

### Signature
`public function topupBalance(int $amount, ?string $paymentMethod = null, RequestOptions|array|null $requestOptions = null): CreditTopupBalanceResponse`

### Parameters
- **amount** (int) - Required - Amount in credits.
- **paymentMethod** (?string) - Optional - Payment method (e.g., card).
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration options.

### Returns
- **CreditTopupBalanceResponse** - Transaction information.
```

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

### Retrieve subscription details via SubscribeService

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Fetches detailed information for a specific subscription plan by ID.

```php
public function retrieve(
    string $id,
    RequestOptions|array|null $requestOptions = null
): SubscriptionDetail
```

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

### User Operations

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

Retrieve followers and perform follow actions.

```APIDOC
## $client->x->users->retrieveFollowers(id, pageSize)

### Description
Retrieves a list of followers for a given user ID.

## $client->x->users->follow->create(sourceAccount, targetUserID)

### Description
Follows a specific user from a source account.
```

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

### Retrieve Monitor

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Fetches details and current matches for a specific monitor ID.

```php
public function retrieve(
    string $id,
    RequestOptions|array|null $requestOptions = null
): MonitorDetail
```

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

### Webhooks

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

Create and manage webhooks for event notifications.

```APIDOC
## $client->webhooks->create(url, events)

### Description
Registers a new webhook URL to receive notifications for specified events.
```

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

### list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists all draws with pagination support.

```APIDOC
## list()

### Description
Lists all draws with pagination.

### Parameters
- **afterCursor** (string) - Optional - Cursor for pagination
- **limit** (int) - Optional - Number of results to return (default: 50)
- **requestOptions** (RequestOptions|array) - Optional - Request configuration

### Returns
- **DrawListResponse** - List of draws
```

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

### test()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Sends a test payload to the webhook.

```APIDOC
## test()

### Description
Sends a test payload to the webhook.

### Parameters
- **id** (string) - Required - The ID of the webhook to test.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **WebhookTestResponse** - HTTP response details from the test.
```

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

### List API keys

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Retrieves a list of all API keys associated with the account.

```php
public function list(
    RequestOptions|array|null $requestOptions = null
): APIKeyListResponse
```

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

### Handle API Exceptions in PHP

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Use specific catch blocks to handle authentication, rate limiting, and resource availability issues.

```php
<?php

use XTwitterScraper\Core\Exceptions\APIException;
use XTwitterScraper\Core\Exceptions\AuthenticationException;
use XTwitterScraper\Core\Exceptions\RateLimitException;
use XTwitterScraper\Core\Exceptions\NotFoundException;

try {
    $tweets = $client->x->tweets->search(q: 'PHP');
} catch (AuthenticationException $e) {
    echo "Invalid API key: " . $e->getMessage();
} catch (RateLimitException $e) {
    echo "Rate limited. Try again later.";
} catch (NotFoundException $e) {
    echo "Resource not found: " . $e->getMessage();
} catch (APIException $e) {
    echo "API error: " . $e->status . " - " . $e->getMessage();
}
```

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

### List X accounts

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Retrieves a list of all linked X accounts and iterates through them to access username and follower count.

```php
$accounts = $client->x->accounts->list();
foreach ($accounts->accounts as $account) {
    echo $account->username;
    echo $account->followers;
}
```

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

### List user lists

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Retrieves a list of the user's lists, supporting optional pagination via cursor and limit parameters.

```php
public function list(
    ?string $cursor = null,
    ?int $limit = null,
    RequestOptions|array|null $requestOptions = null,
): ListListResponse
```

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

### list(?string $afterCursor, int $limit, RequestOptions|array|null $requestOptions)

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists all saved drafts with pagination.

```APIDOC
## list(?string $afterCursor, int $limit, RequestOptions|array|null $requestOptions)

### Description
Lists all saved drafts with pagination.

### Parameters
- **afterCursor** (?string) - Optional - Pagination cursor
- **limit** (int) - Optional - Max items per page (1-100)
- **requestOptions** (RequestOptions|array|null) - Optional - Request configuration

### Returns
- **DraftListResponse** - Paginated list of drafts
```

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

### WebhooksService Methods

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

Methods for managing webhooks, including listing, creating, retrieving, deleting, and testing.

```APIDOC
## WebhooksService Methods

- `list(requestOptions?): WebhookListResponse`
- `create(url, events?, requestOptions?): WebhookDetail`
- `retrieve(id, requestOptions?): WebhookDetail`
- `delete(id, requestOptions?): void`
- `test(id, requestOptions?): WebhookTestResponse`
```

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

### list()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Lists extraction jobs with optional filtering by status, tool type, and pagination parameters.

```APIDOC
## list(status, toolType, afterCursor, limit, requestOptions)

### Description
Lists extraction jobs with optional filtering.

### Parameters
- **status** (?Status) - Optional - Filter by status (Running, Completed, Failed)
- **toolType** (?ToolType) - Optional - Filter by tool type
- **afterCursor** (?string) - Optional - Pagination cursor
- **limit** (int) - Optional - Max items per page (default: 50)

### Returns
- **ExtractionListResponse** - The list of extraction jobs.

### Throws
- **APIException**
```

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

### Create a new tweet draft

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Initializes a new draft with optional AI-assisted goals and topic context.

```php
public function create(
    string $text,
    Goal|string|null $goal = null,
    ?string $topic = null,
    RequestOptions|array|null $requestOptions = null,
): DraftDetail
```

```php
$draft = $client->drafts->create(
    text: 'Check out this new feature!',
    goal: 'Engagement',
    topic: 'Product announcement'
);

echo $draft->id;
```

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

### Join a community

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/additional-x-services.md

Sends a request to join a specific community.

```php
public function create(
    string $communityID,
    RequestOptions|array|null $requestOptions = null
): CommunityJoinResponse
```

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

### Bookmarks Management

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Methods for listing, creating, and removing bookmarks.

```APIDOC
## $client->x->bookmarks->list(limit)

### Description
Lists bookmarked tweets.

## $client->x->bookmarks->create(tweetID)

### Description
Bookmarks a specific tweet.

## $client->x->bookmarks->delete(tweetID)

### Description
Removes a bookmark for a specific tweet.
```

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

### Run a draw

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Executes the selection process for a draw to determine winners.

```php
public function run(
    string $id,
    ?int $winnerCount = null,
    RequestOptions|array|null $requestOptions = null,
): DrawRunResponse
```

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

### $client->x->users->retrieve()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/getting-started.md

Retrieves the profile information for a specific user by their username.

```APIDOC
## $client->x->users->retrieve()

### Description
Fetches user profile details including name, username, follower count, and bio.

### Parameters
- **username** (string) - Required - The username of the profile to retrieve.
```

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

### ComposeService::create()

Source: https://github.com/xquik-dev/x-twitter-scraper-php/blob/main/_autodocs/core-services.md

Generates tweet suggestions based on a provided prompt.

```APIDOC
## ComposeService::create()

### Description
Generates tweet suggestions based on prompt.

### Parameters
- **prompt** (string) - Required - Composition prompt or topic.
- **style** (string|null) - Optional - Writing style to apply.
- **context** (array|null) - Optional - Additional context data.
- **requestOptions** (RequestOptions|array|null) - Optional - Configuration options for the request.

### Returns
- **ComposeNewResponse** - Generated suggestions.

### Throws
- **APIException**

### Example
$response = $client->compose->create(
    prompt: 'Announce a new product launch',
    style: 'Professional'
);

foreach ($response->suggestions as $suggestion) {
    echo $suggestion->text;
}
```
Tokens:
Raw