Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-twitter-streaming-api
Easily work with the Twitter Streaming API in a Laravel app
https://github.com/spatie/laravel-twitter-streaming-api
api laravel php streaming tweets twitter
Last synced: 1 day ago
JSON representation
Easily work with the Twitter Streaming API in a Laravel app
- Host: GitHub
- URL: https://github.com/spatie/laravel-twitter-streaming-api
- Owner: spatie
- License: mit
- Created: 2017-01-12T22:35:36.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-28T09:53:57.000Z (11 months ago)
- Last Synced: 2025-01-15T13:51:18.196Z (8 days ago)
- Topics: api, laravel, php, streaming, tweets, twitter
- Language: PHP
- Homepage: https://freek.dev/671-easily-work-with-the-twitter-streaming-api-in-php
- Size: 113 KB
- Stars: 202
- Watchers: 6
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Easily work with the Twitter Streaming API in a Laravel app
[](https://packagist.org/packages/spatie/laravel-twitter-streaming-api)
[](LICENSE.md)
[](https://packagist.org/packages/spatie/laravel-twitter-streaming-api)
Twitter provides a streaming API with which you can do interesting things such as listening for tweets that contain
specific strings or actions a user might take (e.g. liking a tweet, following someone,...). This package makes it very
easy to work with the API.
```php
TwitterStreamingApi::publicStream()
->whenHears('#laravel', function(array $tweet) {
echo "{$tweet['user']['screen_name']} tweeted {$tweet['text']}";
})
->startListening();
```
Here's [an example Laravel application](https://github.com/spatie/laravel-twitter-streaming-api-example-app) with the
package pre-installed. It
contains [an artisan command](https://github.com/spatie/laravel-twitter-streaming-api-example-app/blob/master/app/Console/Commands/ListenForHashTags.php)
to kick off the listening process.
## Support us
[
](https://spatie.be/github-ad-click/laravel-twitter-streaming-api)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can
support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards
on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
``` bash
composer require spatie/laravel-twitter-streaming-api
```
The config file must be published with this command:
```bash
php artisan vendor:publish --provider="Spatie\LaravelTwitterStreamingApi\TwitterStreamingApiServiceProvider" --tag="config"
```
It will be published in `config/laravel-twitter-streaming-api.php`
```php
return [
/*
* To work with Twitter's Streaming API you'll need some credentials.
*
* If you don't have credentials yet, head over to https://developers.twitter.com/
*/
'handle' => env('TWITTER_HANDLE'),
'api_key' => env('TWITTER_API_KEY'),
'api_secret_key' => env('TWITTER_API_SECRET_KEY'),
'bearer_token' => env('TWITTER_BEARER_TOKEN'),
];
```
## Getting credentials
In order to use this package you'll need to get some credentials from Twitter. Head over to
the [Developer Portal on Twitter](https://developers.twitter.com/) to create an application.
Once you've created your application, click on the `Keys and tokens` tab to retrieve your `bearer_token`, `api_key`
and `api_secret_key`.
## Usage
Currently, this package works with the public stream and the user stream. Both the `PublicStream` and `UserStream`
classes provide a `startListening` function that kicks of the listening process. Unless you cancel it your PHP process
will execute that function forever. No code after the function will be run.
In the example below a facade is used. If you don't like facades you can replace them with
```php
app(Spatie\LaravelTwitterStreamingApi\TwitterStreamingApi::class)
```
### The public stream
The public stream can be used to listen for specific words that are being tweeted.
The first parameter of `whenHears` must be a string, or an array containing the word or words you want to listen for. The
second parameter should be a callable that will be executed when one of your words is used on Twitter.
```php
use TwitterStreamingApi;
TwitterStreamingApi::publicStream()
->whenHears('#laravel', function(array $tweet) {
echo "{$tweet['user']['screen_name']} tweeted {$tweet['text']}";
})
->startListening();
```
### The user stream
```php
use TwitterStreamingApi;
TwitterStreamingApi::userStream()
->onEvent(function(array $event) {
if ($event['event'] === 'favorite') {
echo "Our tweet {$event['target_object']['text']} got favorited by {$event['source']['screen_name']}";
}
})
->startListening();
```
## Suggestion on how to run in a production environment
When using this in production you could opt to
create [an artisan command](https://github.com/spatie/laravel-twitter-streaming-api-example-app/blob/8175995/app/Console/Commands/ListenForHashTags.php)
to listen for incoming events from Twitter. You can use [Supervisord](http://supervisord.org/) to make sure that command
is running all the time.
## A word to the wise
These APIs work in realtime, so they could report a lot of activity. If you need to do some heavy work processing that
activity it's best to put that work in a queue to keep your listening process fast.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.