atymic/twitter

By default, the package uses API v1.1.

To set API v2 as the global default, set TWITTER_API_VERSION=2 in your .env file.

To switch versions fluently in your code:

• Use Twitter::forApiV2() to get an instance of the v2 client.
• Use Twitter::forApiV1() to get an instance of the v1 client.

Note: It is safe to call Twitter::forApiV1() on either a v1 or v2 client instance.

// If default is v1.1, get v2 client
$v2Client = Twitter::forApiV2();

// If default is v2, get v1 client
$v1Client = Twitter::forApiV1();

For advanced configuration, publish the package's configuration file to your config/ directory using the Artisan command:

php artisan vendor:publish --provider="Atymic\Twitter\ServiceProvider\LaravelServiceProvider"

To successfully set up a Twitter webhook, your endpoint must respond to a challenge request by returning a hash of the provided crc_token using the Twitter::crcHash() method.

Route::post('twitter/webhook', ['as' => 'twitter.webhook', function(){
	if (request()->has('crc_token'))
		return response()->json(['response_token' => Twitter::crcHash(request()->crc_token)], 200);
	
	// Your webhook logic goes here
}]);

The configuration keys in the ttwitter config file have changed in version 3.x.

If you have not published or modified the config file, you can skip this step as the environment variable names remain unchanged.

If you have custom configurations, follow these steps:

1. Publish the new configuration file using the Artisan command below.
2. Compare your existing ttwitter config file with the newly published one.
3. Manually migrate your custom settings to the new format.
4. Delete the old configuration file.

php artisan vendor:publish --provider="Atymic\Twitter\ServiceProvider\LaravelServiceProvider"

To set up the package in a Laravel application, add the following environment variables to your .env file:

• TWITTER_CONSUMER_KEY
• TWITTER_CONSUMER_SECRET
• TWITTER_ACCESS_TOKEN
• TWITTER_ACCESS_TOKEN_SECRET
• TWITTER_API_VERSION

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=
TWITTER_API_VERSION=

Install the package using Composer. For version 3.x, use the following command:

composer require atymic/twitter:^3.0 -W

To debug API calls, first enable debug mode in your configuration file. You can then catch exceptions and use Twitter::logs() to inspect the request/response history.

try {
    $response = Twitter::getUserTimeline(['count' => 20, 'response_format' => 'array']);
} catch (Exception $e) {
    dd(Twitter::logs());
}

The v1.1 API provides several methods for managing the authenticating user's account settings, profile, and credentials.

Account Management

• getSettings(): Returns settings including current trend, geo, and sleep time information.
• getCredentials(): Retrieves account credentials.
• postSettings(): Updates the authenticating user's settings.
• postSettingsDevice(): Sets the device for Twitter updates. Sending none as the device parameter disables SMS updates.
• postProfile(): Updates specific values under the 'Account' tab of settings.
• postBackground(): Updates or enables/disables the profile background image.
• postProfileImage(): Updates the profile image. Note: This method expects raw multipart data, not an image URL.
• destroyUserBanner(): Removes the profile banner. Returns HTTP 200 on success.
• postUserBanner(): Uploads a profile banner.

Manage liked (favorited) Tweets.

• getFavorites(): Returns the 20 most recent Tweets favorited by the user (or a specified user).
• destroyFavorite($id): Un-favorites a status by ID.
• postFavorite($id): Favorites a status by ID.

Real-time data and metrics using API v2.

Streaming

• getStreamRules(): Returns active rules on the streaming endpoint.
• postStreamRules(...): Adds or deletes rules for the stream.
• getStream(...): Streams Tweets in real-time based on filter rules.
• getSampledStream(): Streams approximately 1% of all Tweets in real-time.

Tweet Counts

• countRecent(...): Count of Tweets matching a query in the last 7 days.
• countAll(...): Count of all Tweets matching a query. Note: Requires Academic Research product track.

Other

• hideTweet($id): Hides or unhides a reply to a Tweet.