trait TwitterSearchTweetsClient extends AnyRef
Implements the available requests for the v2 search tweets
resource.
- Alphabetic
- By Inheritance
- TwitterSearchTweetsClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val restClient: RestClient
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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 thesince_id
. If the limit of Tweets has occurred since thesince_id
, thesince_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 theuntil_id
. If the limit of Tweets has occurred since theuntil_id
, theuntil_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 theexpansions=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 theexpansions=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 theexpansions=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 thereferenced_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.
- 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 thesince_id
. If the limit of Tweets has occurred since thesince_id
, thesince_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 theuntil_id
. If the limit of Tweets has occurred since theuntil_id
, theuntil_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 theexpansions=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 theexpansions=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 theexpansions=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 thereferenced_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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])