Starts a streaming connection from Twitter's public API, filtered with the 'follow', 'track' and 'location' parameters.
Starts a streaming connection from Twitter's public API, filtered with the 'follow', 'track' and 'location' parameters.
Although all of those three params are optional, at least one must be specified.
The track, follow, and locations fields should be considered to be combined with an OR operator.
The function returns a future of a TwitterStream
that can be use to close or replace the stream when needed.
If there are failures in establishing the initial connection, the Future returned will be completed with a failure.
Since it's an asynchronous event stream, all the events will be parsed as entities of type CommonStreamingMessage
and processed accordingly to the partial function f
. All the messages that do not match f
are automatically ignored.
For more information see
https://dev.twitter.com/streaming/reference/post/statuses/filter.
: Empty by default. A comma separated list of user IDs, indicating the users to return statuses for in the stream. For more information https://dev.twitter.com/streaming/overview/request-parameters#follow
: Empty by default. Keywords to track. Phrases of keywords are specified by a comma-separated list. For more information https://dev.twitter.com/streaming/overview/request-parameters#track
: Empty by default. Specifies a set of bounding boxes to track. For more information https://dev.twitter.com/streaming/overview/request-parameters#locations
: Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language
: Default to false. Specifies whether stall warnings (WarningMessage
) should be delivered as part of the updates.
Starts a streaming connection from Twitter's firehose API of all public statuses.
Starts a streaming connection from Twitter's firehose API of all public statuses.
Few applications require this level of access.
Creative use of a combination of other resources and various access levels can satisfy nearly every application use case.
For more information see
https://dev.twitter.com/streaming/reference/get/statuses/firehose.
The function returns a future of a TwitterStream
that can be use to close or replace the stream when needed.
If there are failures in establishing the initial connection, the Future returned will be completed with a failure.
Since it's an asynchronous event stream, all the events will be parsed as entities of type CommonStreamingMessage
and processed accordingly to the partial function f
. All the messages that do not match f
are automatically ignored.
: Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language
: Default to false. Specifies whether stall warnings (WarningMessage
) should be delivered as part of the updates.
Starts a streaming connection from Twitter's public API, which is a a small random sample of all public statuses.
Starts a streaming connection from Twitter's public API, which is a a small random sample of all public statuses.
The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets.
The function returns a future of a TwitterStream
that can be use to close or replace the stream when needed.
If there are failures in establishing the initial connection, the Future returned will be completed with a failure.
Since it's an asynchronous event stream, all the events will be parsed as entities of type CommonStreamingMessage
and processed accordingly to the partial function f
. All the messages that do not match f
are automatically ignored.
For more information see
https://dev.twitter.com/streaming/reference/get/statuses/sample.
: Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language
: Default to false. Specifies whether stall warnings (WarningMessage
) should be delivered as part of the updates.
Starts a streaming connection from Twitter's site API.
Starts a streaming connection from Twitter's site API. SStreams messages for a set of users,
as described in Site streams.
The function returns a future of a TwitterStream
that can be use to close or replace the stream when needed.
If there are failures in establishing the initial connection, the Future returned will be completed with a failure.
Since it's an asynchronous event stream, all the events will be parsed as entities of type SiteStreamingMessage
and processed accordingly to the partial function f
. All the messages that do not match f
are automatically ignored.
For more information see
https://dev.twitter.com/streaming/reference/get/site.
: Empty by default. A comma separated list of user IDs, indicating the users to return statuses for in the stream. For more information https://dev.twitter.com/streaming/overview/request-parameters#follow
: Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language
: Default to false. Specifies whether stall warnings (WarningMessage
) should be delivered as part of the updates.
Starts a streaming connection from Twitter's user API.
Starts a streaming connection from Twitter's user API. Streams messages for a single user as
described in User streams.
The function returns a future of a TwitterStream
that can be use to close or replace the stream when needed.
If there are failures in establishing the initial connection, the Future returned will be completed with a failure.
Since it's an asynchronous event stream, all the events will be parsed as entities of type UserStreamingMessage
and processed accordingly to the partial function f
. All the messages that do not match f
are automatically ignored.
For more information see
https://dev.twitter.com/streaming/reference/get/statuses/sample.
: Empty by default. Keywords to track. Phrases of keywords are specified by a comma-separated list. For more information see https://dev.twitter.com/streaming/overview/request-parameters#track
: Empty by default. Specifies a set of bounding boxes to track. For more information see https://dev.twitter.com/streaming/overview/request-parameters#locations
: Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language
: Default to false. Specifies whether stall warnings (WarningMessage
) should be delivered as part of the updates.
(Since version 2.2) use siteEvents instead
(Since version 2.2) use filterStatuses instead
(Since version 2.2) use firehoseStatuses instead
(Since version 2.2) use sampleStatuses instead
(Since version 2.2) use userEvents instead