x-twitter-scraper 0.7.2 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +3 -3
- data/lib/x_twitter_scraper/models/credit_topup_balance_response.rb +5 -5
- data/lib/x_twitter_scraper/models/draw_export_params.rb +8 -3
- data/lib/x_twitter_scraper/models/draw_list_params.rb +2 -2
- data/lib/x_twitter_scraper/models/error.rb +8 -0
- data/lib/x_twitter_scraper/models/event_list_params.rb +13 -5
- data/lib/x_twitter_scraper/models/extraction_estimate_cost_params.rb +731 -82
- data/lib/x_twitter_scraper/models/extraction_estimate_cost_response.rb +1 -0
- data/lib/x_twitter_scraper/models/extraction_export_results_params.rb +145 -1
- data/lib/x_twitter_scraper/models/extraction_list_params.rb +2 -2
- data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb +70 -3
- data/lib/x_twitter_scraper/models/extraction_run_params.rb +662 -1
- data/lib/x_twitter_scraper/models/extraction_run_response.rb +27 -48
- data/lib/x_twitter_scraper/models/guest_wallet_create_response.rb +8 -8
- data/lib/x_twitter_scraper/models/guest_wallet_topup_response.rb +9 -9
- data/lib/x_twitter_scraper/models/monitor.rb +29 -1
- data/lib/x_twitter_scraper/models/paginated_tweets.rb +4 -4
- data/lib/x_twitter_scraper/models/paginated_users.rb +5 -5
- data/lib/x_twitter_scraper/models/support/attachment_download_params.rb +28 -0
- data/lib/x_twitter_scraper/models/x/community_retrieve_members_params.rb +113 -1
- data/lib/x_twitter_scraper/models/x/community_retrieve_moderators_params.rb +117 -1
- data/lib/x_twitter_scraper/models/x/list_retrieve_followers_params.rb +117 -6
- data/lib/x_twitter_scraper/models/x/list_retrieve_members_params.rb +116 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_favoriters_params.rb +117 -6
- data/lib/x_twitter_scraper/models/x/tweet_get_quotes_params.rb +153 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb +246 -16
- data/lib/x_twitter_scraper/models/x/tweet_get_replies_response.rb +3 -2
- data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_params.rb +117 -6
- data/lib/x_twitter_scraper/models/x/tweet_search_params.rb +187 -14
- data/lib/x_twitter_scraper/models/x/tweet_search_response.rb +299 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_followers_params.rb +143 -10
- data/lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb +241 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb +117 -6
- data/lib/x_twitter_scraper/models/x/user_retrieve_following_params.rb +143 -10
- data/lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb +241 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_likes_params.rb +153 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_media_params.rb +153 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb +153 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_replies_params.rb +159 -7
- data/lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb +116 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_params.rb +159 -7
- data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rb +157 -8
- data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rb +245 -0
- data/lib/x_twitter_scraper/models/x/x_account.rb +7 -11
- data/lib/x_twitter_scraper/resources/credits.rb +2 -2
- data/lib/x_twitter_scraper/resources/draws.rb +5 -2
- data/lib/x_twitter_scraper/resources/events.rb +10 -4
- data/lib/x_twitter_scraper/resources/extractions.rb +383 -84
- data/lib/x_twitter_scraper/resources/guest_wallets.rb +9 -13
- data/lib/x_twitter_scraper/resources/support/attachments.rb +42 -0
- data/lib/x_twitter_scraper/resources/support.rb +5 -0
- data/lib/x_twitter_scraper/resources/x/communities.rb +95 -4
- data/lib/x_twitter_scraper/resources/x/lists.rb +96 -5
- data/lib/x_twitter_scraper/resources/x/tweets.rb +286 -28
- data/lib/x_twitter_scraper/resources/x/users.rb +531 -41
- data/lib/x_twitter_scraper/version.rb +1 -1
- data/lib/x_twitter_scraper.rb +7 -1
- data/rbi/x_twitter_scraper/models/credit_topup_balance_response.rbi +6 -6
- data/rbi/x_twitter_scraper/models/draw_export_params.rbi +6 -3
- data/rbi/x_twitter_scraper/models/draw_list_params.rbi +2 -2
- data/rbi/x_twitter_scraper/models/error.rbi +40 -0
- data/rbi/x_twitter_scraper/models/event_list_params.rbi +15 -4
- data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi +1338 -86
- data/rbi/x_twitter_scraper/models/extraction_estimate_cost_response.rbi +5 -0
- data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi +198 -0
- data/rbi/x_twitter_scraper/models/extraction_list_params.rbi +2 -2
- data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi +194 -2
- data/rbi/x_twitter_scraper/models/extraction_run_params.rbi +1221 -0
- data/rbi/x_twitter_scraper/models/extraction_run_response.rbi +35 -162
- data/rbi/x_twitter_scraper/models/guest_wallet_create_response.rbi +8 -6
- data/rbi/x_twitter_scraper/models/guest_wallet_topup_response.rbi +9 -7
- data/rbi/x_twitter_scraper/models/monitor.rbi +54 -3
- data/rbi/x_twitter_scraper/models/paginated_tweets.rbi +4 -4
- data/rbi/x_twitter_scraper/models/paginated_users.rbi +5 -5
- data/rbi/x_twitter_scraper/models/support/attachment_download_params.rbi +51 -0
- data/rbi/x_twitter_scraper/models/x/community_retrieve_members_params.rbi +154 -0
- data/rbi/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbi +154 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_followers_params.rbi +160 -8
- data/rbi/x_twitter_scraper/models/x/list_retrieve_members_params.rbi +154 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbi +160 -8
- data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_params.rbi +209 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi +403 -20
- data/rbi/x_twitter_scraper/models/x/tweet_get_replies_response.rbi +3 -2
- data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbi +160 -8
- data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi +279 -16
- data/rbi/x_twitter_scraper/models/x/tweet_search_response.rbi +543 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi +228 -12
- data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_response.rbi +440 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi +160 -8
- data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi +228 -12
- data/rbi/x_twitter_scraper/models/x/user_retrieve_following_response.rbi +440 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_params.rbi +209 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_media_params.rbi +209 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi +209 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_replies_params.rbi +217 -8
- data/rbi/x_twitter_scraper/models/x/user_retrieve_search_params.rbi +154 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi +217 -8
- data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbi +248 -10
- data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbi +440 -0
- data/rbi/x_twitter_scraper/models/x/x_account.rbi +9 -15
- data/rbi/x_twitter_scraper/resources/credits.rbi +2 -2
- data/rbi/x_twitter_scraper/resources/draws.rbi +3 -2
- data/rbi/x_twitter_scraper/resources/events.rbi +5 -2
- data/rbi/x_twitter_scraper/resources/extractions.rbi +525 -83
- data/rbi/x_twitter_scraper/resources/guest_wallets.rbi +9 -13
- data/rbi/x_twitter_scraper/resources/support/attachments.rbi +35 -0
- data/rbi/x_twitter_scraper/resources/support.rbi +4 -0
- data/rbi/x_twitter_scraper/resources/x/communities.rbi +84 -0
- data/rbi/x_twitter_scraper/resources/x/lists.rbi +87 -4
- data/rbi/x_twitter_scraper/resources/x/tweets.rbi +307 -31
- data/rbi/x_twitter_scraper/resources/x/users.rbi +558 -34
- data/sig/x_twitter_scraper/models/error.rbs +16 -0
- data/sig/x_twitter_scraper/models/event_list_params.rbs +7 -0
- data/sig/x_twitter_scraper/models/extraction_estimate_cost_params.rbs +605 -1
- data/sig/x_twitter_scraper/models/extraction_estimate_cost_response.rbs +2 -0
- data/sig/x_twitter_scraper/models/extraction_export_results_params.rbs +127 -1
- data/sig/x_twitter_scraper/models/extraction_retrieve_params.rbs +74 -1
- data/sig/x_twitter_scraper/models/extraction_run_params.rbs +611 -1
- data/sig/x_twitter_scraper/models/extraction_run_response.rbs +29 -67
- data/sig/x_twitter_scraper/models/guest_wallet_create_response.rbs +4 -4
- data/sig/x_twitter_scraper/models/guest_wallet_topup_response.rbs +4 -4
- data/sig/x_twitter_scraper/models/monitor.rbs +29 -3
- data/sig/x_twitter_scraper/models/support/attachment_download_params.rbs +32 -0
- data/sig/x_twitter_scraper/models/x/community_retrieve_members_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbs +102 -1
- data/sig/x_twitter_scraper/models/x/list_retrieve_followers_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/list_retrieve_members_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_quotes_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs +207 -2
- data/sig/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/tweet_search_params.rbs +154 -1
- data/sig/x_twitter_scraper/models/x/tweet_search_response.rbs +258 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_params.rbs +119 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_response.rbs +216 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbs +103 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_following_params.rbs +119 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_following_response.rbs +216 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_likes_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_media_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_replies_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_search_params.rbs +102 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbs +134 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbs +137 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbs +216 -0
- data/sig/x_twitter_scraper/resources/events.rbs +1 -0
- data/sig/x_twitter_scraper/resources/extractions.rbs +137 -0
- data/sig/x_twitter_scraper/resources/support/attachments.rbs +15 -0
- data/sig/x_twitter_scraper/resources/support.rbs +2 -0
- data/sig/x_twitter_scraper/resources/x/communities.rbs +28 -0
- data/sig/x_twitter_scraper/resources/x/lists.rbs +28 -0
- data/sig/x_twitter_scraper/resources/x/tweets.rbs +93 -1
- data/sig/x_twitter_scraper/resources/x/users.rbs +173 -3
- metadata +19 -1
|
@@ -13,17 +13,32 @@ module XTwitterScraper
|
|
|
13
13
|
params(
|
|
14
14
|
id: String,
|
|
15
15
|
cursor: String,
|
|
16
|
+
field_style:
|
|
17
|
+
XTwitterScraper::ExtractionRetrieveParams::FieldStyle::OrSymbol,
|
|
18
|
+
include_raw: T::Boolean,
|
|
16
19
|
limit: Integer,
|
|
20
|
+
output_mode:
|
|
21
|
+
XTwitterScraper::ExtractionRetrieveParams::OutputMode::OrSymbol,
|
|
22
|
+
output_preset:
|
|
23
|
+
XTwitterScraper::ExtractionRetrieveParams::OutputPreset::OrSymbol,
|
|
17
24
|
request_options: XTwitterScraper::RequestOptions::OrHash
|
|
18
25
|
).returns(XTwitterScraper::Models::ExtractionRetrieveResponse)
|
|
19
26
|
end
|
|
20
27
|
def retrieve(
|
|
21
28
|
# Extraction public ID (UUID)
|
|
22
29
|
id,
|
|
23
|
-
#
|
|
30
|
+
# Previous nextCursor.
|
|
24
31
|
cursor: nil,
|
|
32
|
+
# Preserve source keys or convert result field names.
|
|
33
|
+
field_style: nil,
|
|
34
|
+
# Use outputMode=raw instead.
|
|
35
|
+
include_raw: nil,
|
|
25
36
|
# Maximum number of results to return (1-1000, default 100)
|
|
26
37
|
limit: nil,
|
|
38
|
+
# Select compact, full, or raw-compatible result fields.
|
|
39
|
+
output_mode: nil,
|
|
40
|
+
# Keep enrichment nested or merge it into each result.
|
|
41
|
+
output_preset: nil,
|
|
27
42
|
request_options: {}
|
|
28
43
|
)
|
|
29
44
|
end
|
|
@@ -39,7 +54,7 @@ module XTwitterScraper
|
|
|
39
54
|
).returns(XTwitterScraper::Models::ExtractionListResponse)
|
|
40
55
|
end
|
|
41
56
|
def list(
|
|
42
|
-
#
|
|
57
|
+
# Previous nextCursor.
|
|
43
58
|
cursor: nil,
|
|
44
59
|
# Maximum number of items to return (1-100, default 50). For paid per-result
|
|
45
60
|
# endpoints, the returned count may be lower when remaining credits cannot cover
|
|
@@ -61,132 +76,315 @@ module XTwitterScraper
|
|
|
61
76
|
XTwitterScraper::ExtractionEstimateCostParams::ToolType::OrSymbol,
|
|
62
77
|
advanced_query: String,
|
|
63
78
|
any_words: String,
|
|
79
|
+
bio_contains: String,
|
|
80
|
+
blue_verified_only: T::Boolean,
|
|
64
81
|
bounding_box: String,
|
|
82
|
+
card_name: String,
|
|
65
83
|
cashtags: String,
|
|
84
|
+
collection_strategy:
|
|
85
|
+
XTwitterScraper::ExtractionEstimateCostParams::CollectionStrategy::OrSymbol,
|
|
66
86
|
conversation_id: String,
|
|
87
|
+
dedupe_across_targets: T::Boolean,
|
|
88
|
+
dedupe_mode:
|
|
89
|
+
XTwitterScraper::ExtractionEstimateCostParams::DedupeMode::OrSymbol,
|
|
67
90
|
exact_phrase: String,
|
|
91
|
+
exclude_original_author: T::Boolean,
|
|
92
|
+
exclude_source: String,
|
|
68
93
|
exclude_words: String,
|
|
69
94
|
from_user: String,
|
|
95
|
+
geocode: String,
|
|
70
96
|
hashtags: String,
|
|
97
|
+
has_location: T::Boolean,
|
|
98
|
+
has_media_only: T::Boolean,
|
|
99
|
+
has_website: T::Boolean,
|
|
100
|
+
include_original_post: T::Boolean,
|
|
101
|
+
include_search_terms: T::Boolean,
|
|
102
|
+
include_target_metadata: T::Boolean,
|
|
71
103
|
in_reply_to_tweet_id: String,
|
|
72
104
|
language: String,
|
|
73
105
|
list_id: String,
|
|
106
|
+
location_contains: String,
|
|
107
|
+
max_depth: Integer,
|
|
108
|
+
max_followers: Integer,
|
|
109
|
+
max_following: Integer,
|
|
110
|
+
max_id: String,
|
|
111
|
+
max_items_per_target: Integer,
|
|
112
|
+
max_likes: Integer,
|
|
113
|
+
max_pages_per_target: Integer,
|
|
114
|
+
max_posts: Integer,
|
|
115
|
+
max_quotes: Integer,
|
|
116
|
+
max_replies: Integer,
|
|
117
|
+
max_retweets: Integer,
|
|
74
118
|
media_type:
|
|
75
119
|
XTwitterScraper::ExtractionEstimateCostParams::MediaType::OrSymbol,
|
|
76
120
|
mentioning: String,
|
|
121
|
+
min_account_age_days: Integer,
|
|
122
|
+
min_bookmarks: Integer,
|
|
77
123
|
min_faves: Integer,
|
|
124
|
+
min_followers: Integer,
|
|
125
|
+
min_following: Integer,
|
|
126
|
+
min_posts: Integer,
|
|
78
127
|
min_quotes: Integer,
|
|
79
128
|
min_replies: Integer,
|
|
80
129
|
min_retweets: Integer,
|
|
130
|
+
min_views: Integer,
|
|
131
|
+
native_retweets: T::Boolean,
|
|
132
|
+
near: String,
|
|
133
|
+
news: T::Boolean,
|
|
134
|
+
overlap_mode: T::Boolean,
|
|
81
135
|
place: String,
|
|
82
136
|
place_country: String,
|
|
83
137
|
point_radius: String,
|
|
138
|
+
query_type:
|
|
139
|
+
XTwitterScraper::ExtractionEstimateCostParams::QueryType::OrSymbol,
|
|
84
140
|
quotes:
|
|
85
141
|
XTwitterScraper::ExtractionEstimateCostParams::Quotes::OrSymbol,
|
|
86
142
|
quotes_of_tweet_id: String,
|
|
143
|
+
relation_targets:
|
|
144
|
+
T::Array[
|
|
145
|
+
XTwitterScraper::ExtractionEstimateCostParams::RelationTarget::OrHash
|
|
146
|
+
],
|
|
87
147
|
replies:
|
|
88
148
|
XTwitterScraper::ExtractionEstimateCostParams::Replies::OrSymbol,
|
|
89
149
|
results_limit: Integer,
|
|
90
150
|
retweets:
|
|
91
151
|
XTwitterScraper::ExtractionEstimateCostParams::Retweets::OrSymbol,
|
|
92
152
|
retweets_of_tweet_id: String,
|
|
153
|
+
safe: T::Boolean,
|
|
154
|
+
scope: XTwitterScraper::ExtractionEstimateCostParams::Scope::OrSymbol,
|
|
155
|
+
search_queries: T::Array[String],
|
|
93
156
|
search_query: String,
|
|
94
157
|
since_date: Date,
|
|
158
|
+
since_id: String,
|
|
159
|
+
since_time:
|
|
160
|
+
XTwitterScraper::ExtractionEstimateCostParams::SinceTime::Variants,
|
|
161
|
+
sort: XTwitterScraper::ExtractionEstimateCostParams::Sort::OrSymbol,
|
|
162
|
+
source: String,
|
|
163
|
+
start_cursor: String,
|
|
95
164
|
target_community_id: String,
|
|
165
|
+
target_community_ids: T::Array[String],
|
|
96
166
|
target_list_id: String,
|
|
167
|
+
target_list_ids: T::Array[String],
|
|
168
|
+
targets:
|
|
169
|
+
T::Array[
|
|
170
|
+
T.any(
|
|
171
|
+
String,
|
|
172
|
+
XTwitterScraper::ExtractionEstimateCostParams::Target::UnionMember1::OrHash
|
|
173
|
+
)
|
|
174
|
+
],
|
|
97
175
|
target_space_id: String,
|
|
98
176
|
target_tweet_id: String,
|
|
177
|
+
target_tweet_ids: T::Array[String],
|
|
99
178
|
target_username: String,
|
|
179
|
+
target_usernames: T::Array[String],
|
|
100
180
|
to_user: String,
|
|
101
181
|
until_date: Date,
|
|
182
|
+
until_time:
|
|
183
|
+
XTwitterScraper::ExtractionEstimateCostParams::UntilTime::Variants,
|
|
102
184
|
url: String,
|
|
185
|
+
username_contains: String,
|
|
103
186
|
verified_only: T::Boolean,
|
|
187
|
+
verified_type: String,
|
|
188
|
+
within: String,
|
|
189
|
+
within_time: String,
|
|
104
190
|
request_options: XTwitterScraper::RequestOptions::OrHash
|
|
105
191
|
).returns(XTwitterScraper::Models::ExtractionEstimateCostResponse)
|
|
106
192
|
end
|
|
107
193
|
def estimate_cost(
|
|
108
194
|
# Identifier for the extraction tool used to run a job.
|
|
109
195
|
tool_type:,
|
|
110
|
-
# Raw advanced query
|
|
196
|
+
# Raw advanced search query appended as-is (tweet_search_extractor)
|
|
111
197
|
advanced_query: nil,
|
|
112
|
-
#
|
|
113
|
-
#
|
|
198
|
+
# Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
199
|
+
# or lines. (tweet_search_extractor)
|
|
114
200
|
any_words: nil,
|
|
115
|
-
#
|
|
116
|
-
|
|
201
|
+
# Bio terms separated by commas or lines.
|
|
202
|
+
bio_contains: nil,
|
|
203
|
+
# Return only Blue-verified Tweet authors.
|
|
204
|
+
blue_verified_only: nil,
|
|
205
|
+
# Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
|
|
117
206
|
bounding_box: nil,
|
|
118
|
-
#
|
|
207
|
+
# Match the Tweet card name.
|
|
208
|
+
card_name: nil,
|
|
209
|
+
# Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
119
210
|
cashtags: nil,
|
|
120
|
-
#
|
|
211
|
+
# Reply collection strategy.
|
|
212
|
+
collection_strategy: nil,
|
|
213
|
+
# Conversation ID filter (tweet_search_extractor)
|
|
121
214
|
conversation_id: nil,
|
|
122
|
-
#
|
|
215
|
+
# Merge duplicate results across collection targets.
|
|
216
|
+
dedupe_across_targets: nil,
|
|
217
|
+
# Keep target duplicates, first rows, or merged overlap.
|
|
218
|
+
dedupe_mode: nil,
|
|
219
|
+
# Exact phrase to match (tweet_search_extractor)
|
|
123
220
|
exact_phrase: nil,
|
|
124
|
-
#
|
|
125
|
-
|
|
221
|
+
# Exclude replies from the source author.
|
|
222
|
+
exclude_original_author: nil,
|
|
223
|
+
# Exclude a source application.
|
|
224
|
+
exclude_source: nil,
|
|
225
|
+
# Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
226
|
+
# (tweet_search_extractor)
|
|
126
227
|
exclude_words: nil,
|
|
127
|
-
#
|
|
228
|
+
# Filter by author username (tweet_search_extractor)
|
|
128
229
|
from_user: nil,
|
|
129
|
-
#
|
|
230
|
+
# Match latitude, longitude, and radius.
|
|
231
|
+
geocode: nil,
|
|
232
|
+
# Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
130
233
|
hashtags: nil,
|
|
131
|
-
#
|
|
234
|
+
# Require a profile location.
|
|
235
|
+
has_location: nil,
|
|
236
|
+
# Return only replies with media.
|
|
237
|
+
has_media_only: nil,
|
|
238
|
+
# Require a profile website.
|
|
239
|
+
has_website: nil,
|
|
240
|
+
# Include the source post in reply results.
|
|
241
|
+
include_original_post: nil,
|
|
242
|
+
# Add matching search terms to collection metadata.
|
|
243
|
+
include_search_terms: nil,
|
|
244
|
+
# Add source target metadata to each result.
|
|
245
|
+
include_target_metadata: nil,
|
|
246
|
+
# Only replies to this tweet ID (tweet_search_extractor)
|
|
132
247
|
in_reply_to_tweet_id: nil,
|
|
133
|
-
# Language code
|
|
248
|
+
# Language code filter (tweet_search_extractor)
|
|
134
249
|
language: nil,
|
|
135
|
-
#
|
|
250
|
+
# Search within a list ID (tweet_search_extractor)
|
|
136
251
|
list_id: nil,
|
|
137
|
-
#
|
|
252
|
+
# Required profile location text.
|
|
253
|
+
location_contains: nil,
|
|
254
|
+
# Maximum nested reply depth.
|
|
255
|
+
max_depth: nil,
|
|
256
|
+
# Maximum follower count for profile results.
|
|
257
|
+
max_followers: nil,
|
|
258
|
+
# Maximum following count for profile results.
|
|
259
|
+
max_following: nil,
|
|
260
|
+
# Return Tweets older than this Tweet ID.
|
|
261
|
+
max_id: nil,
|
|
262
|
+
# Maximum results collected for each target.
|
|
263
|
+
max_items_per_target: nil,
|
|
264
|
+
# Maximum Tweet like count.
|
|
265
|
+
max_likes: nil,
|
|
266
|
+
# Reply pages collected for each target.
|
|
267
|
+
max_pages_per_target: nil,
|
|
268
|
+
# Maximum post count for profile results.
|
|
269
|
+
max_posts: nil,
|
|
270
|
+
# Maximum Tweet quote count.
|
|
271
|
+
max_quotes: nil,
|
|
272
|
+
# Maximum Tweet reply count.
|
|
273
|
+
max_replies: nil,
|
|
274
|
+
# Maximum Tweet repost count.
|
|
275
|
+
max_retweets: nil,
|
|
276
|
+
# Media type filter (tweet_search_extractor)
|
|
138
277
|
media_type: nil,
|
|
139
|
-
#
|
|
278
|
+
# Filter tweets mentioning a username (tweet_search_extractor)
|
|
140
279
|
mentioning: nil,
|
|
141
|
-
# Minimum
|
|
280
|
+
# Minimum profile age in days.
|
|
281
|
+
min_account_age_days: nil,
|
|
282
|
+
# Minimum Tweet bookmark count.
|
|
283
|
+
min_bookmarks: nil,
|
|
284
|
+
# Minimum likes threshold (tweet_search_extractor)
|
|
142
285
|
min_faves: nil,
|
|
143
|
-
# Minimum
|
|
286
|
+
# Minimum follower count for profile results.
|
|
287
|
+
min_followers: nil,
|
|
288
|
+
# Minimum following count for profile results.
|
|
289
|
+
min_following: nil,
|
|
290
|
+
# Minimum post count for profile results.
|
|
291
|
+
min_posts: nil,
|
|
292
|
+
# Minimum quote count threshold (tweet_search_extractor)
|
|
144
293
|
min_quotes: nil,
|
|
145
|
-
# Minimum replies threshold
|
|
294
|
+
# Minimum replies threshold (tweet_search_extractor)
|
|
146
295
|
min_replies: nil,
|
|
147
|
-
# Minimum retweets threshold
|
|
296
|
+
# Minimum retweets threshold (tweet_search_extractor)
|
|
148
297
|
min_retweets: nil,
|
|
149
|
-
#
|
|
298
|
+
# Minimum Tweet view count.
|
|
299
|
+
min_views: nil,
|
|
300
|
+
# Only return native reposts.
|
|
301
|
+
native_retweets: nil,
|
|
302
|
+
# Match a place name.
|
|
303
|
+
near: nil,
|
|
304
|
+
# Only return news results.
|
|
305
|
+
news: nil,
|
|
306
|
+
# Shortcut for dedupeMode=merge.
|
|
307
|
+
overlap_mode: nil,
|
|
308
|
+
# Search within a place ID (tweet_search_extractor)
|
|
150
309
|
place: nil,
|
|
151
|
-
#
|
|
310
|
+
# Search within a country code (tweet_search_extractor)
|
|
152
311
|
place_country: nil,
|
|
153
|
-
# Geo point radius
|
|
154
|
-
# (tweet_search_extractor)
|
|
312
|
+
# Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
|
|
155
313
|
point_radius: nil,
|
|
156
|
-
#
|
|
314
|
+
# Search ranking applied to every query.
|
|
315
|
+
query_type: nil,
|
|
316
|
+
# Quote mode (tweet_search_extractor)
|
|
157
317
|
quotes: nil,
|
|
158
|
-
#
|
|
318
|
+
# Only quotes of this tweet ID (tweet_search_extractor)
|
|
159
319
|
quotes_of_tweet_id: nil,
|
|
160
|
-
#
|
|
320
|
+
# Profile relations processed within one job.
|
|
321
|
+
relation_targets: nil,
|
|
322
|
+
# Reply mode (tweet_search_extractor)
|
|
161
323
|
replies: nil,
|
|
162
|
-
# Maximum number of results to
|
|
163
|
-
#
|
|
324
|
+
# Maximum number of results to extract. When set, the extraction stops after
|
|
325
|
+
# reaching this limit.
|
|
164
326
|
results_limit: nil,
|
|
165
|
-
# Retweet mode
|
|
327
|
+
# Retweet mode (tweet_search_extractor)
|
|
166
328
|
retweets: nil,
|
|
167
|
-
#
|
|
329
|
+
# Only retweets of this tweet ID (tweet_search_extractor)
|
|
168
330
|
retweets_of_tweet_id: nil,
|
|
169
|
-
#
|
|
331
|
+
# Enable the safe-search filter.
|
|
332
|
+
safe: nil,
|
|
333
|
+
# Reply depth scope.
|
|
334
|
+
scope: nil,
|
|
335
|
+
# Search queries processed as one collection job.
|
|
336
|
+
search_queries: nil,
|
|
337
|
+
# Required for tweet_search_extractor & community_search.
|
|
170
338
|
search_query: nil,
|
|
171
|
-
#
|
|
339
|
+
# Start date YYYY-MM-DD (tweet_search_extractor)
|
|
172
340
|
since_date: nil,
|
|
173
|
-
#
|
|
341
|
+
# Return Tweets newer than this Tweet ID.
|
|
342
|
+
since_id: nil,
|
|
343
|
+
# Reply start time as ISO 8601 or Unix seconds.
|
|
344
|
+
since_time: nil,
|
|
345
|
+
# Reply result order.
|
|
346
|
+
sort: nil,
|
|
347
|
+
# Match the source application.
|
|
348
|
+
source: nil,
|
|
349
|
+
# Resume one reply target from this cursor.
|
|
350
|
+
start_cursor: nil,
|
|
351
|
+
# Required for community_post_extractor & community_search.
|
|
174
352
|
target_community_id: nil,
|
|
175
|
-
#
|
|
353
|
+
# Community IDs processed as one collection job.
|
|
354
|
+
target_community_ids: nil,
|
|
355
|
+
# Required for list_follower_explorer, list_member_extractor &
|
|
176
356
|
# list_post_extractor.
|
|
177
357
|
target_list_id: nil,
|
|
178
|
-
#
|
|
358
|
+
# List IDs processed as one collection job.
|
|
359
|
+
target_list_ids: nil,
|
|
360
|
+
# Mixed targets auto-routed within one job.
|
|
361
|
+
targets: nil,
|
|
362
|
+
# Required for space_explorer.
|
|
179
363
|
target_space_id: nil,
|
|
180
364
|
target_tweet_id: nil,
|
|
365
|
+
# Tweet IDs processed as one collection job.
|
|
366
|
+
target_tweet_ids: nil,
|
|
181
367
|
target_username: nil,
|
|
182
|
-
#
|
|
368
|
+
# Usernames processed as one collection job.
|
|
369
|
+
target_usernames: nil,
|
|
370
|
+
# Filter replies sent to a username (tweet_search_extractor)
|
|
183
371
|
to_user: nil,
|
|
184
|
-
#
|
|
372
|
+
# End date YYYY-MM-DD (tweet_search_extractor)
|
|
185
373
|
until_date: nil,
|
|
186
|
-
#
|
|
374
|
+
# Reply end time as ISO 8601 or Unix seconds.
|
|
375
|
+
until_time: nil,
|
|
376
|
+
# URL substring or domain filter (tweet_search_extractor)
|
|
187
377
|
url: nil,
|
|
188
|
-
#
|
|
378
|
+
# Required username text.
|
|
379
|
+
username_contains: nil,
|
|
380
|
+
# Only verified authors (tweet_search_extractor)
|
|
189
381
|
verified_only: nil,
|
|
382
|
+
# Exact profile verification type.
|
|
383
|
+
verified_type: nil,
|
|
384
|
+
# Set the radius for the near filter.
|
|
385
|
+
within: nil,
|
|
386
|
+
# Match Tweets inside a recent time window.
|
|
387
|
+
within_time: nil,
|
|
190
388
|
request_options: {}
|
|
191
389
|
)
|
|
192
390
|
end
|
|
@@ -197,6 +395,24 @@ module XTwitterScraper
|
|
|
197
395
|
id: String,
|
|
198
396
|
format_:
|
|
199
397
|
XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol,
|
|
398
|
+
has_description: T::Boolean,
|
|
399
|
+
has_location: T::Boolean,
|
|
400
|
+
has_media: T::Boolean,
|
|
401
|
+
lang: String,
|
|
402
|
+
max_followers: Integer,
|
|
403
|
+
max_following: Integer,
|
|
404
|
+
max_posts: Integer,
|
|
405
|
+
min_followers: Integer,
|
|
406
|
+
min_following: Integer,
|
|
407
|
+
min_likes: Integer,
|
|
408
|
+
min_posts: Integer,
|
|
409
|
+
min_replies: Integer,
|
|
410
|
+
min_retweets: Integer,
|
|
411
|
+
min_views: Integer,
|
|
412
|
+
search: String,
|
|
413
|
+
since_date: Date,
|
|
414
|
+
until_date: Date,
|
|
415
|
+
verified: T::Boolean,
|
|
200
416
|
request_options: XTwitterScraper::RequestOptions::OrHash
|
|
201
417
|
).returns(StringIO)
|
|
202
418
|
end
|
|
@@ -205,6 +421,42 @@ module XTwitterScraper
|
|
|
205
421
|
id,
|
|
206
422
|
# Export file format
|
|
207
423
|
format_:,
|
|
424
|
+
# Require a non-empty description.
|
|
425
|
+
has_description: nil,
|
|
426
|
+
# Require a non-empty location.
|
|
427
|
+
has_location: nil,
|
|
428
|
+
# Require media.
|
|
429
|
+
has_media: nil,
|
|
430
|
+
# Filter by language code.
|
|
431
|
+
lang: nil,
|
|
432
|
+
# Maximum follower count.
|
|
433
|
+
max_followers: nil,
|
|
434
|
+
# Maximum following count.
|
|
435
|
+
max_following: nil,
|
|
436
|
+
# Maximum post count.
|
|
437
|
+
max_posts: nil,
|
|
438
|
+
# Minimum follower count.
|
|
439
|
+
min_followers: nil,
|
|
440
|
+
# Minimum following count.
|
|
441
|
+
min_following: nil,
|
|
442
|
+
# Minimum like count.
|
|
443
|
+
min_likes: nil,
|
|
444
|
+
# Minimum post count.
|
|
445
|
+
min_posts: nil,
|
|
446
|
+
# Minimum reply count.
|
|
447
|
+
min_replies: nil,
|
|
448
|
+
# Minimum repost count.
|
|
449
|
+
min_retweets: nil,
|
|
450
|
+
# Minimum view count.
|
|
451
|
+
min_views: nil,
|
|
452
|
+
# Search exported result text.
|
|
453
|
+
search: nil,
|
|
454
|
+
# Include results on or after this date.
|
|
455
|
+
since_date: nil,
|
|
456
|
+
# Include results on or before this date.
|
|
457
|
+
until_date: nil,
|
|
458
|
+
# Filter by verified status.
|
|
459
|
+
verified: nil,
|
|
208
460
|
request_options: {}
|
|
209
461
|
)
|
|
210
462
|
end
|
|
@@ -213,128 +465,318 @@ module XTwitterScraper
|
|
|
213
465
|
sig do
|
|
214
466
|
params(
|
|
215
467
|
tool_type: XTwitterScraper::ExtractionRunParams::ToolType::OrSymbol,
|
|
468
|
+
dry_run: T::Boolean,
|
|
216
469
|
advanced_query: String,
|
|
217
470
|
any_words: String,
|
|
471
|
+
bio_contains: String,
|
|
472
|
+
blue_verified_only: T::Boolean,
|
|
218
473
|
bounding_box: String,
|
|
474
|
+
card_name: String,
|
|
219
475
|
cashtags: String,
|
|
476
|
+
collection_strategy:
|
|
477
|
+
XTwitterScraper::ExtractionRunParams::CollectionStrategy::OrSymbol,
|
|
220
478
|
conversation_id: String,
|
|
479
|
+
dedupe_across_targets: T::Boolean,
|
|
480
|
+
dedupe_mode:
|
|
481
|
+
XTwitterScraper::ExtractionRunParams::DedupeMode::OrSymbol,
|
|
221
482
|
exact_phrase: String,
|
|
483
|
+
exclude_original_author: T::Boolean,
|
|
484
|
+
exclude_source: String,
|
|
222
485
|
exclude_words: String,
|
|
223
486
|
from_user: String,
|
|
487
|
+
geocode: String,
|
|
224
488
|
hashtags: String,
|
|
489
|
+
has_location: T::Boolean,
|
|
490
|
+
has_media_only: T::Boolean,
|
|
491
|
+
has_website: T::Boolean,
|
|
492
|
+
include_original_post: T::Boolean,
|
|
493
|
+
include_search_terms: T::Boolean,
|
|
494
|
+
include_target_metadata: T::Boolean,
|
|
225
495
|
in_reply_to_tweet_id: String,
|
|
226
496
|
language: String,
|
|
227
497
|
list_id: String,
|
|
498
|
+
location_contains: String,
|
|
499
|
+
max_depth: Integer,
|
|
500
|
+
max_followers: Integer,
|
|
501
|
+
max_following: Integer,
|
|
502
|
+
max_id: String,
|
|
503
|
+
max_items_per_target: Integer,
|
|
504
|
+
max_likes: Integer,
|
|
505
|
+
max_pages_per_target: Integer,
|
|
506
|
+
max_posts: Integer,
|
|
507
|
+
max_quotes: Integer,
|
|
508
|
+
max_replies: Integer,
|
|
509
|
+
max_retweets: Integer,
|
|
228
510
|
media_type: XTwitterScraper::ExtractionRunParams::MediaType::OrSymbol,
|
|
229
511
|
mentioning: String,
|
|
512
|
+
min_account_age_days: Integer,
|
|
513
|
+
min_bookmarks: Integer,
|
|
230
514
|
min_faves: Integer,
|
|
515
|
+
min_followers: Integer,
|
|
516
|
+
min_following: Integer,
|
|
517
|
+
min_posts: Integer,
|
|
231
518
|
min_quotes: Integer,
|
|
232
519
|
min_replies: Integer,
|
|
233
520
|
min_retweets: Integer,
|
|
521
|
+
min_views: Integer,
|
|
522
|
+
native_retweets: T::Boolean,
|
|
523
|
+
near: String,
|
|
524
|
+
news: T::Boolean,
|
|
525
|
+
overlap_mode: T::Boolean,
|
|
234
526
|
place: String,
|
|
235
527
|
place_country: String,
|
|
236
528
|
point_radius: String,
|
|
529
|
+
query_type: XTwitterScraper::ExtractionRunParams::QueryType::OrSymbol,
|
|
237
530
|
quotes: XTwitterScraper::ExtractionRunParams::Quotes::OrSymbol,
|
|
238
531
|
quotes_of_tweet_id: String,
|
|
532
|
+
relation_targets:
|
|
533
|
+
T::Array[
|
|
534
|
+
XTwitterScraper::ExtractionRunParams::RelationTarget::OrHash
|
|
535
|
+
],
|
|
239
536
|
replies: XTwitterScraper::ExtractionRunParams::Replies::OrSymbol,
|
|
240
537
|
results_limit: Integer,
|
|
241
538
|
retweets: XTwitterScraper::ExtractionRunParams::Retweets::OrSymbol,
|
|
242
539
|
retweets_of_tweet_id: String,
|
|
540
|
+
safe: T::Boolean,
|
|
541
|
+
scope: XTwitterScraper::ExtractionRunParams::Scope::OrSymbol,
|
|
542
|
+
search_queries: T::Array[String],
|
|
243
543
|
search_query: String,
|
|
244
544
|
since_date: Date,
|
|
545
|
+
since_id: String,
|
|
546
|
+
since_time: XTwitterScraper::ExtractionRunParams::SinceTime::Variants,
|
|
547
|
+
sort: XTwitterScraper::ExtractionRunParams::Sort::OrSymbol,
|
|
548
|
+
source: String,
|
|
549
|
+
start_cursor: String,
|
|
245
550
|
target_community_id: String,
|
|
551
|
+
target_community_ids: T::Array[String],
|
|
246
552
|
target_list_id: String,
|
|
553
|
+
target_list_ids: T::Array[String],
|
|
554
|
+
targets:
|
|
555
|
+
T::Array[
|
|
556
|
+
T.any(
|
|
557
|
+
String,
|
|
558
|
+
XTwitterScraper::ExtractionRunParams::Target::UnionMember1::OrHash
|
|
559
|
+
)
|
|
560
|
+
],
|
|
247
561
|
target_space_id: String,
|
|
248
562
|
target_tweet_id: String,
|
|
563
|
+
target_tweet_ids: T::Array[String],
|
|
249
564
|
target_username: String,
|
|
565
|
+
target_usernames: T::Array[String],
|
|
250
566
|
to_user: String,
|
|
251
567
|
until_date: Date,
|
|
568
|
+
until_time: XTwitterScraper::ExtractionRunParams::UntilTime::Variants,
|
|
252
569
|
url: String,
|
|
570
|
+
username_contains: String,
|
|
253
571
|
verified_only: T::Boolean,
|
|
572
|
+
verified_type: String,
|
|
573
|
+
within: String,
|
|
574
|
+
within_time: String,
|
|
254
575
|
request_options: XTwitterScraper::RequestOptions::OrHash
|
|
255
576
|
).returns(XTwitterScraper::Models::ExtractionRunResponse)
|
|
256
577
|
end
|
|
257
578
|
def run(
|
|
258
|
-
# Identifier for the extraction tool used to run a job.
|
|
579
|
+
# Body param: Identifier for the extraction tool used to run a job.
|
|
259
580
|
tool_type:,
|
|
260
|
-
#
|
|
581
|
+
# Query param: Estimate cost without creating an extraction.
|
|
582
|
+
dry_run: nil,
|
|
583
|
+
# Body param: Raw advanced search query appended as-is (tweet_search_extractor)
|
|
261
584
|
advanced_query: nil,
|
|
262
|
-
# Words or quoted phrases where any one can match. Separate with
|
|
263
|
-
# or lines. (tweet_search_extractor)
|
|
585
|
+
# Body param: Words or quoted phrases where any one can match. Separate with
|
|
586
|
+
# spaces, commas, or lines. (tweet_search_extractor)
|
|
264
587
|
any_words: nil,
|
|
265
|
-
#
|
|
588
|
+
# Body param: Bio terms separated by commas or lines.
|
|
589
|
+
bio_contains: nil,
|
|
590
|
+
# Body param: Return only Blue-verified Tweet authors.
|
|
591
|
+
blue_verified_only: nil,
|
|
592
|
+
# Body param: Geo bounding box, e.g. -74.1 40.6 -73.9 40.8
|
|
593
|
+
# (tweet_search_extractor)
|
|
266
594
|
bounding_box: nil,
|
|
267
|
-
#
|
|
595
|
+
# Body param: Match the Tweet card name.
|
|
596
|
+
card_name: nil,
|
|
597
|
+
# Body param: Cashtags separated by spaces, commas, or lines.
|
|
598
|
+
# (tweet_search_extractor)
|
|
268
599
|
cashtags: nil,
|
|
269
|
-
#
|
|
600
|
+
# Body param: Reply collection strategy.
|
|
601
|
+
collection_strategy: nil,
|
|
602
|
+
# Body param: Conversation ID filter (tweet_search_extractor)
|
|
270
603
|
conversation_id: nil,
|
|
271
|
-
#
|
|
604
|
+
# Body param: Merge duplicate results across collection targets.
|
|
605
|
+
dedupe_across_targets: nil,
|
|
606
|
+
# Body param: Keep target duplicates, first rows, or merged overlap.
|
|
607
|
+
dedupe_mode: nil,
|
|
608
|
+
# Body param: Exact phrase to match (tweet_search_extractor)
|
|
272
609
|
exact_phrase: nil,
|
|
273
|
-
#
|
|
274
|
-
|
|
610
|
+
# Body param: Exclude replies from the source author.
|
|
611
|
+
exclude_original_author: nil,
|
|
612
|
+
# Body param: Exclude a source application.
|
|
613
|
+
exclude_source: nil,
|
|
614
|
+
# Body param: Words or quoted phrases to exclude. Separate with spaces, commas, or
|
|
615
|
+
# lines. (tweet_search_extractor)
|
|
275
616
|
exclude_words: nil,
|
|
276
|
-
# Filter by author username (tweet_search_extractor)
|
|
617
|
+
# Body param: Filter by author username (tweet_search_extractor)
|
|
277
618
|
from_user: nil,
|
|
278
|
-
#
|
|
619
|
+
# Body param: Match latitude, longitude, and radius.
|
|
620
|
+
geocode: nil,
|
|
621
|
+
# Body param: Hashtags separated by spaces, commas, or lines.
|
|
622
|
+
# (tweet_search_extractor)
|
|
279
623
|
hashtags: nil,
|
|
280
|
-
#
|
|
624
|
+
# Body param: Require a profile location.
|
|
625
|
+
has_location: nil,
|
|
626
|
+
# Body param: Return only replies with media.
|
|
627
|
+
has_media_only: nil,
|
|
628
|
+
# Body param: Require a profile website.
|
|
629
|
+
has_website: nil,
|
|
630
|
+
# Body param: Include the source post in reply results.
|
|
631
|
+
include_original_post: nil,
|
|
632
|
+
# Body param: Add matching search terms to collection metadata.
|
|
633
|
+
include_search_terms: nil,
|
|
634
|
+
# Body param: Add source target metadata to each result.
|
|
635
|
+
include_target_metadata: nil,
|
|
636
|
+
# Body param: Only replies to this tweet ID (tweet_search_extractor)
|
|
281
637
|
in_reply_to_tweet_id: nil,
|
|
282
|
-
# Language code filter (tweet_search_extractor)
|
|
638
|
+
# Body param: Language code filter (tweet_search_extractor)
|
|
283
639
|
language: nil,
|
|
284
|
-
# Search within a list ID (tweet_search_extractor)
|
|
640
|
+
# Body param: Search within a list ID (tweet_search_extractor)
|
|
285
641
|
list_id: nil,
|
|
286
|
-
#
|
|
642
|
+
# Body param: Required profile location text.
|
|
643
|
+
location_contains: nil,
|
|
644
|
+
# Body param: Maximum nested reply depth.
|
|
645
|
+
max_depth: nil,
|
|
646
|
+
# Body param: Maximum follower count for profile results.
|
|
647
|
+
max_followers: nil,
|
|
648
|
+
# Body param: Maximum following count for profile results.
|
|
649
|
+
max_following: nil,
|
|
650
|
+
# Body param: Return Tweets older than this Tweet ID.
|
|
651
|
+
max_id: nil,
|
|
652
|
+
# Body param: Maximum results collected for each target.
|
|
653
|
+
max_items_per_target: nil,
|
|
654
|
+
# Body param: Maximum Tweet like count.
|
|
655
|
+
max_likes: nil,
|
|
656
|
+
# Body param: Reply pages collected for each target.
|
|
657
|
+
max_pages_per_target: nil,
|
|
658
|
+
# Body param: Maximum post count for profile results.
|
|
659
|
+
max_posts: nil,
|
|
660
|
+
# Body param: Maximum Tweet quote count.
|
|
661
|
+
max_quotes: nil,
|
|
662
|
+
# Body param: Maximum Tweet reply count.
|
|
663
|
+
max_replies: nil,
|
|
664
|
+
# Body param: Maximum Tweet repost count.
|
|
665
|
+
max_retweets: nil,
|
|
666
|
+
# Body param: Media type filter (tweet_search_extractor)
|
|
287
667
|
media_type: nil,
|
|
288
|
-
# Filter tweets mentioning a username (tweet_search_extractor)
|
|
668
|
+
# Body param: Filter tweets mentioning a username (tweet_search_extractor)
|
|
289
669
|
mentioning: nil,
|
|
290
|
-
# Minimum
|
|
670
|
+
# Body param: Minimum profile age in days.
|
|
671
|
+
min_account_age_days: nil,
|
|
672
|
+
# Body param: Minimum Tweet bookmark count.
|
|
673
|
+
min_bookmarks: nil,
|
|
674
|
+
# Body param: Minimum likes threshold (tweet_search_extractor)
|
|
291
675
|
min_faves: nil,
|
|
292
|
-
# Minimum
|
|
676
|
+
# Body param: Minimum follower count for profile results.
|
|
677
|
+
min_followers: nil,
|
|
678
|
+
# Body param: Minimum following count for profile results.
|
|
679
|
+
min_following: nil,
|
|
680
|
+
# Body param: Minimum post count for profile results.
|
|
681
|
+
min_posts: nil,
|
|
682
|
+
# Body param: Minimum quote count threshold (tweet_search_extractor)
|
|
293
683
|
min_quotes: nil,
|
|
294
|
-
# Minimum replies threshold (tweet_search_extractor)
|
|
684
|
+
# Body param: Minimum replies threshold (tweet_search_extractor)
|
|
295
685
|
min_replies: nil,
|
|
296
|
-
# Minimum retweets threshold (tweet_search_extractor)
|
|
686
|
+
# Body param: Minimum retweets threshold (tweet_search_extractor)
|
|
297
687
|
min_retweets: nil,
|
|
298
|
-
#
|
|
688
|
+
# Body param: Minimum Tweet view count.
|
|
689
|
+
min_views: nil,
|
|
690
|
+
# Body param: Only return native reposts.
|
|
691
|
+
native_retweets: nil,
|
|
692
|
+
# Body param: Match a place name.
|
|
693
|
+
near: nil,
|
|
694
|
+
# Body param: Only return news results.
|
|
695
|
+
news: nil,
|
|
696
|
+
# Body param: Shortcut for dedupeMode=merge.
|
|
697
|
+
overlap_mode: nil,
|
|
698
|
+
# Body param: Search within a place ID (tweet_search_extractor)
|
|
299
699
|
place: nil,
|
|
300
|
-
# Search within a country code (tweet_search_extractor)
|
|
700
|
+
# Body param: Search within a country code (tweet_search_extractor)
|
|
301
701
|
place_country: nil,
|
|
302
|
-
# Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
|
|
702
|
+
# Body param: Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
|
|
303
703
|
point_radius: nil,
|
|
304
|
-
#
|
|
704
|
+
# Body param: Search ranking applied to every query.
|
|
705
|
+
query_type: nil,
|
|
706
|
+
# Body param: Quote mode (tweet_search_extractor)
|
|
305
707
|
quotes: nil,
|
|
306
|
-
# Only quotes of this tweet ID (tweet_search_extractor)
|
|
708
|
+
# Body param: Only quotes of this tweet ID (tweet_search_extractor)
|
|
307
709
|
quotes_of_tweet_id: nil,
|
|
308
|
-
#
|
|
710
|
+
# Body param: Profile relations processed within one job.
|
|
711
|
+
relation_targets: nil,
|
|
712
|
+
# Body param: Reply mode (tweet_search_extractor)
|
|
309
713
|
replies: nil,
|
|
310
|
-
# Maximum number of results to extract. When set, the extraction stops
|
|
311
|
-
# reaching this limit.
|
|
714
|
+
# Body param: Maximum number of results to extract. When set, the extraction stops
|
|
715
|
+
# after reaching this limit.
|
|
312
716
|
results_limit: nil,
|
|
313
|
-
# Retweet mode (tweet_search_extractor)
|
|
717
|
+
# Body param: Retweet mode (tweet_search_extractor)
|
|
314
718
|
retweets: nil,
|
|
315
|
-
# Only retweets of this tweet ID (tweet_search_extractor)
|
|
719
|
+
# Body param: Only retweets of this tweet ID (tweet_search_extractor)
|
|
316
720
|
retweets_of_tweet_id: nil,
|
|
317
|
-
#
|
|
721
|
+
# Body param: Enable the safe-search filter.
|
|
722
|
+
safe: nil,
|
|
723
|
+
# Body param: Reply depth scope.
|
|
724
|
+
scope: nil,
|
|
725
|
+
# Body param: Search queries processed as one collection job.
|
|
726
|
+
search_queries: nil,
|
|
727
|
+
# Body param: Required for tweet_search_extractor & community_search.
|
|
318
728
|
search_query: nil,
|
|
319
|
-
# Start date YYYY-MM-DD (tweet_search_extractor)
|
|
729
|
+
# Body param: Start date YYYY-MM-DD (tweet_search_extractor)
|
|
320
730
|
since_date: nil,
|
|
321
|
-
#
|
|
731
|
+
# Body param: Return Tweets newer than this Tweet ID.
|
|
732
|
+
since_id: nil,
|
|
733
|
+
# Body param: Reply start time as ISO 8601 or Unix seconds.
|
|
734
|
+
since_time: nil,
|
|
735
|
+
# Body param: Reply result order.
|
|
736
|
+
sort: nil,
|
|
737
|
+
# Body param: Match the source application.
|
|
738
|
+
source: nil,
|
|
739
|
+
# Body param: Resume one reply target from this cursor.
|
|
740
|
+
start_cursor: nil,
|
|
741
|
+
# Body param: Required for community_post_extractor & community_search.
|
|
322
742
|
target_community_id: nil,
|
|
323
|
-
#
|
|
743
|
+
# Body param: Community IDs processed as one collection job.
|
|
744
|
+
target_community_ids: nil,
|
|
745
|
+
# Body param: Required for list_follower_explorer, list_member_extractor &
|
|
324
746
|
# list_post_extractor.
|
|
325
747
|
target_list_id: nil,
|
|
326
|
-
#
|
|
748
|
+
# Body param: List IDs processed as one collection job.
|
|
749
|
+
target_list_ids: nil,
|
|
750
|
+
# Body param: Mixed targets auto-routed within one job.
|
|
751
|
+
targets: nil,
|
|
752
|
+
# Body param: Required for space_explorer.
|
|
327
753
|
target_space_id: nil,
|
|
754
|
+
# Body param
|
|
328
755
|
target_tweet_id: nil,
|
|
756
|
+
# Body param: Tweet IDs processed as one collection job.
|
|
757
|
+
target_tweet_ids: nil,
|
|
758
|
+
# Body param
|
|
329
759
|
target_username: nil,
|
|
330
|
-
#
|
|
760
|
+
# Body param: Usernames processed as one collection job.
|
|
761
|
+
target_usernames: nil,
|
|
762
|
+
# Body param: Filter replies sent to a username (tweet_search_extractor)
|
|
331
763
|
to_user: nil,
|
|
332
|
-
# End date YYYY-MM-DD (tweet_search_extractor)
|
|
764
|
+
# Body param: End date YYYY-MM-DD (tweet_search_extractor)
|
|
333
765
|
until_date: nil,
|
|
334
|
-
#
|
|
766
|
+
# Body param: Reply end time as ISO 8601 or Unix seconds.
|
|
767
|
+
until_time: nil,
|
|
768
|
+
# Body param: URL substring or domain filter (tweet_search_extractor)
|
|
335
769
|
url: nil,
|
|
336
|
-
#
|
|
770
|
+
# Body param: Required username text.
|
|
771
|
+
username_contains: nil,
|
|
772
|
+
# Body param: Only verified authors (tweet_search_extractor)
|
|
337
773
|
verified_only: nil,
|
|
774
|
+
# Body param: Exact profile verification type.
|
|
775
|
+
verified_type: nil,
|
|
776
|
+
# Body param: Set the radius for the near filter.
|
|
777
|
+
within: nil,
|
|
778
|
+
# Body param: Match Tweets inside a recent time window.
|
|
779
|
+
within_time: nil,
|
|
338
780
|
request_options: {}
|
|
339
781
|
)
|
|
340
782
|
end
|