Packages

class TwitterRestV2Client extends V2RestClients with SystemShutdown

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterRestV2Client
  2. SystemShutdown
  3. V2RestClients
  4. TwitterUserLookupClient
  5. TwitterSearchTweetsClient
  6. TwitterTweetLookupClient
  7. TwitterTimelinesClient
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TwitterRestV2Client(consumerToken: ConsumerToken, accessToken: AccessToken)(implicit _system: ActorSystem = ActorSystem("twitter4s-rest-v2"))

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val accessToken: AccessToken
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val consumerToken: ConsumerToken
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def lookupMentions(userId: String, startTime: Option[Instant] = None, endTime: Option[Instant] = None, maxResults: Option[Int] = None, paginationToken: Option[String] = None, sinceId: Option[String] = None, untilId: Option[String] = None, expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetsResponse]]

    Returns Tweets mentioning a single user specified by the requested user ID.

    Returns Tweets mentioning a single user specified by the requested user ID. By default, the most recent ten Tweets are returned per request. Using pagination, up to the most recent 800 Tweets can be retrieved.

    The Tweets returned by this endpoint count towards the Project-level Tweet cap.

    For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets

    userId

    : Unique identifier of the Twitter account (user ID) for whom to return results. User ID can be referenced using the user/lookup endpoint. More information on Twitter IDs is here.

    startTime

    : Optional, by default is None The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z Please note that this parameter does not support a millisecond value.

    endTime

    : Optional, by default is None The newest or most recent UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:01Z Please note that this parameter does not support a millisecond value.

    maxResults

    : Optional, by default is None Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. It is possible to receive less than the max_results per request throughout the pagination process.

    paginationToken

    : Optional, by default is None This parameter is used to move forwards or backwards through 'pages' of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

    sinceId

    : Optional, by default is None Returns results with a Tweet ID greater than (that is, more recent than) the specified 'since' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.

    untilId

    : Optional, by default is None Returns results with a Tweet ID less less than (that is, older than) the specified 'until' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterTimelinesClient
  14. def lookupTimeline(userId: String, startTime: Option[Instant] = None, endTime: Option[Instant] = None, maxResults: Option[Int] = None, paginationToken: Option[String] = None, sinceId: Option[String] = None, untilId: Option[String] = None, exclude: Seq[TimelineExclude] = Seq.empty[TimelineExclude], expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetsResponse]]

    Returns Tweets composed by a single user, specified by the requested user ID.

    Returns Tweets composed by a single user, specified by the requested user ID. By default, the most recent ten Tweets are returned per request. Using pagination, the most recent 3,200 Tweets can be retrieved.

    The Tweets returned by this endpoint count towards the Project-level Tweet cap.

    For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets

    userId

    : Unique identifier of the Twitter account (user ID) for whom to return results. User ID can be referenced using the user/lookup endpoint. More information on Twitter IDs is here.

    startTime

    : Optional, by default is None The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z Please note that this parameter does not support a millisecond value.

    endTime

    : Optional, by default is None The newest or most recent UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:01Z Please note that this parameter does not support a millisecond value.

    maxResults

    : Optional, by default is None Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. It is possible to receive less than the max_results per request throughout the pagination process.

    paginationToken

    : Optional, by default is None This parameter is used to move forwards or backwards through 'pages' of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

    sinceId

    : Optional, by default is None Returns results with a Tweet ID greater than (that is, more recent than) the specified 'since' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.

    untilId

    : Optional, by default is None Returns results with a Tweet ID less less than (that is, older than) the specified 'until' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available.

    exclude

    : Optional, by default is Seq.empty List of the types of Tweets to exclude from the response. When exclude=retweets is used, the maximum historical Tweets returned is still 3200. When the exclude=replies parameter is used for any value, only the most recent 800 Tweets are available.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterTimelinesClient
  15. def lookupTweet(id: String, expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetResponse]]

    Returns a variety of information about a single Tweet specified by the requested ID.

    Returns a variety of information about a single Tweet specified by the requested ID. For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id

    id

    : Unique identifier of the Tweet to request.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the tweet.

    Definition Classes
    TwitterTweetLookupClient
  16. def lookupTweets(ids: Seq[String], expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetsResponse]]

    Returns a variety of information about the Tweet specified by the requested ID or list of IDs.

    Returns a variety of information about the Tweet specified by the requested ID or list of IDs. For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets

    ids

    : A comma separated list of Tweet IDs. Up to 100 are allowed in a single request.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterTweetLookupClient
  17. def lookupUser(id: String, expansions: Seq[UserExpansions] = Seq.empty[UserExpansions], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[UserResponse]]

    Returns a variety of information about a single user specified by the requested ID.

    Returns a variety of information about a single user specified by the requested ID. For more information see https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id

    id

    : The ID of the user to lookup.

    expansions

    : Optional, by default is Seq.empty tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned pinned Tweet. The Tweet fields will only return if the user has a pinned Tweet and if you've also included the expansions=pinned_tweet_id expansion in your request. While the referenced Tweet ID will be located in the original Tweet object, you will find this ID and all additional Tweet fields in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned User object. These specified user fields will display directly in the user data objects.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterUserLookupClient
  18. def lookupUserByUsername(username: String, expansions: Seq[UserExpansions] = Seq.empty[UserExpansions], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[UserResponse]]

    Returns a variety of information about a single user specified by the requested username.

    Returns a variety of information about a single user specified by the requested username. For more information see https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username

    username

    : The Twitter username (handle) of the user.

    expansions

    : Optional, by default is Seq.empty tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned pinned Tweet. The Tweet fields will only return if the user has a pinned Tweet and if you've also included the expansions=pinned_tweet_id expansion in your request. While the referenced Tweet ID will be located in the original Tweet object, you will find this ID and all additional Tweet fields in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned User object. These specified user fields will display directly in the user data objects.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterUserLookupClient
  19. def lookupUsers(ids: Seq[String], expansions: Seq[UserExpansions] = Seq.empty[UserExpansions], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[UsersResponse]]

    Returns a variety of information about one or more users specified by the requested IDs.

    Returns a variety of information about one or more users specified by the requested IDs. For more information see https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users

    ids

    : A comma separated list of user IDs. Up to 100 are allowed in a single request.

    expansions

    : Optional, by default is Seq.empty tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned pinned Tweet. The Tweet fields will only return if the user has a pinned Tweet and if you've also included the expansions=pinned_tweet_id expansion in your request. While the referenced Tweet ID will be located in the original Tweet object, you will find this ID and all additional Tweet fields in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned User object. These specified user fields will display directly in the user data objects.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterUserLookupClient
  20. def lookupUsersByUsernames(usernames: Seq[String], expansions: Seq[UserExpansions] = Seq.empty[UserExpansions], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[UsersResponse]]

    Returns a variety of information about one or more users specified by their usernames.

    Returns a variety of information about one or more users specified by their usernames. For more information see https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by

    usernames

    : A comma separated list of Twitter usernames (handles). Up to 100 are allowed in a single request.

    expansions

    : Optional, by default is Seq.empty tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned pinned Tweet. The Tweet fields will only return if the user has a pinned Tweet and if you've also included the expansions=pinned_tweet_id expansion in your request. While the referenced Tweet ID will be located in the original Tweet object, you will find this ID and all additional Tweet fields in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned User object. These specified user fields will display directly in the user data objects.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterUserLookupClient
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. val restClient: RestClient
  25. def searchAll(query: String, startTime: Option[Instant] = None, endTime: Option[Instant] = None, maxResults: Option[Int] = None, nextToken: Option[String] = None, sinceId: Option[String] = None, untilId: Option[String] = None, expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetsResponse]]

    This endpoint is only available to those users who have been approved for the Academic Research product track.

    This endpoint is only available to those users who have been approved for the Academic Research product track.

    The full-archive search endpoint returns the complete history of public Tweets matching a search query; since the first Tweet was created March 26, 2006.

    The Tweets returned by this endpoint count towards the Project-level Tweet cap.

    For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all

    query

    : One rule for matching Tweets. If you are using a Standard Project at the Basic access level, you can use the basic set of operators and can make queries up to 512 characters long. If you are using an Academic Research Project at the Basic access level, you can use all available operators and can make queries up to 1,024 characters long.

    startTime

    : Optional, by default is None The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z Please note that this parameter does not support a millisecond value.

    endTime

    : Optional, by default is None The newest or most recent UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:01Z Please note that this parameter does not support a millisecond value.

    maxResults

    : Optional, by default is None The maximum number of search results to be returned by a request. A number between 10 and 100. By default, a request response will return 10 results.

    nextToken

    : Optional, by default is None This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

    sinceId

    : Optional, by default is None Returns results with a Tweet ID greater than (that is, more recent than) the specified 'since' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.

    untilId

    : Optional, by default is None Returns results with a Tweet ID less less than (that is, older than) the specified 'until' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterSearchTweetsClient
  26. def searchRecent(query: String, startTime: Option[Instant] = None, endTime: Option[Instant] = None, maxResults: Option[Int] = None, nextToken: Option[String] = None, sinceId: Option[String] = None, untilId: Option[String] = None, expansions: Seq[TweetExpansions] = Seq.empty[TweetExpansions], mediaFields: Seq[MediaFields] = Seq.empty[MediaFields], placeFields: Seq[PlaceFields] = Seq.empty[PlaceFields], pollFields: Seq[PollFields] = Seq.empty[PollFields], tweetFields: Seq[TweetFields] = Seq.empty[TweetFields], userFields: Seq[UserFields] = Seq.empty[UserFields]): Future[RatedData[TweetsResponse]]

    The recent search endpoint returns Tweets from the last seven days that match a search query.

    The recent search endpoint returns Tweets from the last seven days that match a search query.

    The Tweets returned by this endpoint count towards the Project-level Tweet cap.

    For more information see https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent

    query

    : One rule for matching Tweets. If you are using a Standard Project at the Basic access level, you can use the basic set of operators and can make queries up to 512 characters long. If you are using an Academic Research Project at the Basic access level, you can use all available operators and can make queries up to 1,024 characters long.

    startTime

    : Optional, by default is None The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z Please note that this parameter does not support a millisecond value.

    endTime

    : Optional, by default is None The newest or most recent UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:01Z Please note that this parameter does not support a millisecond value.

    maxResults

    : Optional, by default is None The maximum number of search results to be returned by a request. A number between 10 and 100. By default, a request response will return 10 results.

    nextToken

    : Optional, by default is None This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

    sinceId

    : Optional, by default is None Returns results with a Tweet ID greater than (that is, more recent than) the specified 'since' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.

    untilId

    : Optional, by default is None Returns results with a Tweet ID less less than (that is, older than) the specified 'until' Tweet ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available.

    expansions

    : Optional, by default is Seq.empty Expansions enable you to request additional data objects that relate to the originally returned Tweets. The ID that represents the expanded data object will be included directly in the Tweet data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

    mediaFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Media fields will deliver in each returned Tweet. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

    placeFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. The Tweet will only return place fields if the Tweet contains a place and if you've also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

    pollFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

    tweetFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also include the referenced_tweets.id expansion to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

    userFields

    : Optional, by default is Seq.empty This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

    returns

    : The representation of the search results.

    Definition Classes
    TwitterSearchTweetsClient
  27. def shutdown(): Future[Unit]

    Shutdown of the actor system associated to the client

    Shutdown of the actor system associated to the client

    Definition Classes
    SystemShutdown
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val system: ActorSystem
    Attributes
    protected
    Definition Classes
    TwitterRestV2ClientSystemShutdown
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from SystemShutdown

Inherited from V2RestClients

Inherited from TwitterTimelinesClient

Inherited from AnyRef

Inherited from Any

Ungrouped