lookupTweets abstract method

Future<TwitterResponse<List<TweetData>, TweetMeta>> lookupTweets({
  1. required String spaceId,
  2. List<TweetExpansion>? expansions,
  3. List<TweetField>? tweetFields,
  4. List<UserField>? userFields,
  5. List<PlaceField>? placeFields,
  6. List<PollField>? pollFields,
  7. List<MediaField>? mediaFields,
})

Returns Tweets shared in the requested Spaces.

Parameters

  • spaceId: Unique identifier of the Space containing the Tweets you'd like to access.

  • expansions: Expansions enable you to request additional data objects that relate to the originally returned Space. Submit a list of desired expansions in a comma-separated list. The ID that represents the expanded data object will be included directly in the Space 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 Space object.

  • tweetFields: Expansions enable you to request additional data objects that relate to the originally returned Tweets. Submit a list of desired expansions in a comma-separated list without spaces. 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.

  • userFields: This fields parameter enables you to select which specific user fields will deliver in each returned Space. While the user ID will be located in the original Space object, you will find this ID and all additional user fields in the includes data object.

  • placeFields: This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. 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: This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. 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.

  • mediaFields: This fields parameter enables you to select which specific media fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. 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.

Endpoint Url

Authentication Methods

  • OAuth 2.0 Authorization Code with PKCE

Required Scopes

  • tweet.read
  • users.read
  • space.read

Rate Limits

  • User rate limit (OAuth 2.0 user Access Token): 300 requests per 15-minute window per each authenticated user

Reference

Implementation

Future<TwitterResponse<List<TweetData>, TweetMeta>> lookupTweets({
  required String spaceId,
  List<TweetExpansion>? expansions,
  List<TweetField>? tweetFields,
  List<UserField>? userFields,
  List<PlaceField>? placeFields,
  List<PollField>? pollFields,
  List<MediaField>? mediaFields,
});