scrapebadger 0.1.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 +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +548 -0
- data/Rakefile +10 -0
- data/docs/AccountApi.md +76 -0
- data/docs/AccountInfo.md +28 -0
- data/docs/AmazonApi.md +1244 -0
- data/docs/ApartmentsApi.md +373 -0
- data/docs/BaiduApi.md +447 -0
- data/docs/BillingLogListResponse.md +24 -0
- data/docs/BillingLogResponse.md +32 -0
- data/docs/BingApi.md +610 -0
- data/docs/ChatGPTApi.md +521 -0
- data/docs/DepopApi.md +542 -0
- data/docs/DuckDuckGoApi.md +700 -0
- data/docs/EBayApi.md +1019 -0
- data/docs/FacebookApi.md +1671 -0
- data/docs/FilterRuleCreate.md +28 -0
- data/docs/FilterRuleDeliveryLogListResponse.md +24 -0
- data/docs/FilterRuleDeliveryLogResponse.md +44 -0
- data/docs/FilterRuleListResponse.md +24 -0
- data/docs/FilterRuleResponse.md +40 -0
- data/docs/FilterRuleUpdate.md +30 -0
- data/docs/FilterRuleValidateRequest.md +18 -0
- data/docs/FilterRuleValidateResponse.md +22 -0
- data/docs/GoogleApi.md +3175 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/IdealistaApi.md +822 -0
- data/docs/ImmobiliareApi.md +773 -0
- data/docs/InstagramApi.md +1673 -0
- data/docs/LeboncoinApi.md +884 -0
- data/docs/LinkedInApi.md +925 -0
- data/docs/LoopNetApi.md +529 -0
- data/docs/PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md +20 -0
- data/docs/RealtorApi.md +474 -0
- data/docs/RedditApi.md +1677 -0
- data/docs/RedfinApi.md +616 -0
- data/docs/StreamMonitorCreate.md +26 -0
- data/docs/StreamMonitorListResponse.md +24 -0
- data/docs/StreamMonitorResponse.md +42 -0
- data/docs/StreamMonitorUpdate.md +28 -0
- data/docs/SubscriptionInfo.md +40 -0
- data/docs/TikTokApi.md +2104 -0
- data/docs/TweetDeliveryLogListResponse.md +24 -0
- data/docs/TweetDeliveryLogResponse.md +44 -0
- data/docs/TwitterApi.md +4091 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/docs/VintedApi.md +766 -0
- data/docs/WalmartApi.md +904 -0
- data/docs/WebApi.md +634 -0
- data/docs/WebhookCreate.md +22 -0
- data/docs/WebhookListItem.md +28 -0
- data/docs/WebhookListResponse.md +20 -0
- data/docs/WebhookResponse.md +26 -0
- data/docs/WebhookTestRequest.md +18 -0
- data/docs/WebhookTestResponse.md +24 -0
- data/docs/YahooApi.md +602 -0
- data/docs/YandexApi.md +450 -0
- data/docs/YouTubeApi.md +2872 -0
- data/docs/ZillowApi.md +622 -0
- data/git_push.sh +57 -0
- data/lib/scrapebadger/api/account_api.rb +79 -0
- data/lib/scrapebadger/api/amazon_api.rb +1165 -0
- data/lib/scrapebadger/api/apartments_api.rb +377 -0
- data/lib/scrapebadger/api/baidu_api.rb +436 -0
- data/lib/scrapebadger/api/bing_api.rb +580 -0
- data/lib/scrapebadger/api/chat_gpt_api.rb +466 -0
- data/lib/scrapebadger/api/depop_api.rb +518 -0
- data/lib/scrapebadger/api/duck_duck_go_api.rb +675 -0
- data/lib/scrapebadger/api/e_bay_api.rb +1029 -0
- data/lib/scrapebadger/api/facebook_api.rb +1492 -0
- data/lib/scrapebadger/api/google_api.rb +3191 -0
- data/lib/scrapebadger/api/idealista_api.rb +864 -0
- data/lib/scrapebadger/api/immobiliare_api.rb +734 -0
- data/lib/scrapebadger/api/instagram_api.rb +1555 -0
- data/lib/scrapebadger/api/leboncoin_api.rb +818 -0
- data/lib/scrapebadger/api/linked_in_api.rb +832 -0
- data/lib/scrapebadger/api/loop_net_api.rb +503 -0
- data/lib/scrapebadger/api/realtor_api.rb +481 -0
- data/lib/scrapebadger/api/reddit_api.rb +1601 -0
- data/lib/scrapebadger/api/redfin_api.rb +625 -0
- data/lib/scrapebadger/api/tik_tok_api.rb +2029 -0
- data/lib/scrapebadger/api/twitter_api.rb +3696 -0
- data/lib/scrapebadger/api/vinted_api.rb +705 -0
- data/lib/scrapebadger/api/walmart_api.rb +876 -0
- data/lib/scrapebadger/api/web_api.rb +547 -0
- data/lib/scrapebadger/api/yahoo_api.rb +560 -0
- data/lib/scrapebadger/api/yandex_api.rb +422 -0
- data/lib/scrapebadger/api/you_tube_api.rb +2520 -0
- data/lib/scrapebadger/api/zillow_api.rb +634 -0
- data/lib/scrapebadger/api_client.rb +394 -0
- data/lib/scrapebadger/api_error.rb +58 -0
- data/lib/scrapebadger/configuration.rb +308 -0
- data/lib/scrapebadger/models/account_info.rb +288 -0
- data/lib/scrapebadger/models/billing_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/billing_log_response.rb +334 -0
- data/lib/scrapebadger/models/filter_rule_create.rb +427 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/filter_rule_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_response.rb +390 -0
- data/lib/scrapebadger/models/filter_rule_update.rb +389 -0
- data/lib/scrapebadger/models/filter_rule_validate_request.rb +250 -0
- data/lib/scrapebadger/models/filter_rule_validate_response.rb +248 -0
- data/lib/scrapebadger/models/http_validation_error.rb +216 -0
- data/lib/scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response.rb +238 -0
- data/lib/scrapebadger/models/stream_monitor_create.rb +373 -0
- data/lib/scrapebadger/models/stream_monitor_list_response.rb +272 -0
- data/lib/scrapebadger/models/stream_monitor_response.rb +406 -0
- data/lib/scrapebadger/models/stream_monitor_update.rb +335 -0
- data/lib/scrapebadger/models/subscription_info.rb +352 -0
- data/lib/scrapebadger/models/tweet_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/tweet_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/validation_error.rb +255 -0
- data/lib/scrapebadger/models/validation_error_loc_inner.rb +104 -0
- data/lib/scrapebadger/models/webhook_create.rb +282 -0
- data/lib/scrapebadger/models/webhook_list_item.rb +302 -0
- data/lib/scrapebadger/models/webhook_list_response.rb +240 -0
- data/lib/scrapebadger/models/webhook_response.rb +286 -0
- data/lib/scrapebadger/models/webhook_test_request.rb +223 -0
- data/lib/scrapebadger/models/webhook_test_response.rb +259 -0
- data/lib/scrapebadger/version.rb +15 -0
- data/lib/scrapebadger.rb +96 -0
- data/scrapebadger.gemspec +39 -0
- data/spec/api/account_api_spec.rb +46 -0
- data/spec/api/amazon_api_spec.rb +258 -0
- data/spec/api/apartments_api_spec.rb +98 -0
- data/spec/api/baidu_api_spec.rb +109 -0
- data/spec/api/bing_api_spec.rb +141 -0
- data/spec/api/chat_gpt_api_spec.rb +123 -0
- data/spec/api/depop_api_spec.rb +132 -0
- data/spec/api/duck_duck_go_api_spec.rb +162 -0
- data/spec/api/e_bay_api_spec.rb +222 -0
- data/spec/api/facebook_api_spec.rb +326 -0
- data/spec/api/google_api_spec.rb +649 -0
- data/spec/api/idealista_api_spec.rb +197 -0
- data/spec/api/immobiliare_api_spec.rb +174 -0
- data/spec/api/instagram_api_spec.rb +309 -0
- data/spec/api/leboncoin_api_spec.rb +184 -0
- data/spec/api/linked_in_api_spec.rb +197 -0
- data/spec/api/loop_net_api_spec.rb +127 -0
- data/spec/api/realtor_api_spec.rb +123 -0
- data/spec/api/reddit_api_spec.rb +331 -0
- data/spec/api/redfin_api_spec.rb +147 -0
- data/spec/api/tik_tok_api_spec.rb +413 -0
- data/spec/api/twitter_api_spec.rb +735 -0
- data/spec/api/vinted_api_spec.rb +169 -0
- data/spec/api/walmart_api_spec.rb +192 -0
- data/spec/api/web_api_spec.rb +136 -0
- data/spec/api/yahoo_api_spec.rb +137 -0
- data/spec/api/yandex_api_spec.rb +111 -0
- data/spec/api/you_tube_api_spec.rb +500 -0
- data/spec/api/zillow_api_spec.rb +150 -0
- data/spec/models/account_info_spec.rb +66 -0
- data/spec/models/billing_log_list_response_spec.rb +54 -0
- data/spec/models/billing_log_response_spec.rb +78 -0
- data/spec/models/filter_rule_create_spec.rb +66 -0
- data/spec/models/filter_rule_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_delivery_log_response_spec.rb +114 -0
- data/spec/models/filter_rule_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_response_spec.rb +102 -0
- data/spec/models/filter_rule_update_spec.rb +72 -0
- data/spec/models/filter_rule_validate_request_spec.rb +36 -0
- data/spec/models/filter_rule_validate_response_spec.rb +48 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response_spec.rb +42 -0
- data/spec/models/stream_monitor_create_spec.rb +60 -0
- data/spec/models/stream_monitor_list_response_spec.rb +54 -0
- data/spec/models/stream_monitor_response_spec.rb +108 -0
- data/spec/models/stream_monitor_update_spec.rb +66 -0
- data/spec/models/subscription_info_spec.rb +102 -0
- data/spec/models/tweet_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/tweet_delivery_log_response_spec.rb +114 -0
- data/spec/models/validation_error_loc_inner_spec.rb +21 -0
- data/spec/models/validation_error_spec.rb +48 -0
- data/spec/models/webhook_create_spec.rb +48 -0
- data/spec/models/webhook_list_item_spec.rb +66 -0
- data/spec/models/webhook_list_response_spec.rb +42 -0
- data/spec/models/webhook_response_spec.rb +60 -0
- data/spec/models/webhook_test_request_spec.rb +36 -0
- data/spec/models/webhook_test_response_spec.rb +54 -0
- data/spec/spec_helper.rb +111 -0
- metadata +324 -0
data/docs/TwitterApi.md
ADDED
|
@@ -0,0 +1,4091 @@
|
|
|
1
|
+
# ScrapeBadger::TwitterApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://scrapebadger.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**twitter_advanced_tweet_search**](TwitterApi.md#twitter_advanced_tweet_search) | **GET** /v1/twitter/tweets/advanced_search | Advanced tweet search |
|
|
8
|
+
| [**twitter_batch_get_users_by_ids**](TwitterApi.md#twitter_batch_get_users_by_ids) | **GET** /v1/twitter/users/batch_by_ids | Batch get users by IDs |
|
|
9
|
+
| [**twitter_batch_get_users_by_usernames**](TwitterApi.md#twitter_batch_get_users_by_usernames) | **GET** /v1/twitter/users/batch_by_usernames | Batch get users by usernames |
|
|
10
|
+
| [**twitter_configure_webhook_on_a_monitor**](TwitterApi.md#twitter_configure_webhook_on_a_monitor) | **POST** /v1/twitter/stream/webhooks | Configure webhook on a monitor |
|
|
11
|
+
| [**twitter_create_filter_rule**](TwitterApi.md#twitter_create_filter_rule) | **POST** /v1/twitter/stream/filter-rules | Create filter rule |
|
|
12
|
+
| [**twitter_create_stream_monitor**](TwitterApi.md#twitter_create_stream_monitor) | **POST** /v1/twitter/stream/monitors | Create stream monitor |
|
|
13
|
+
| [**twitter_delete_filter_rule**](TwitterApi.md#twitter_delete_filter_rule) | **DELETE** /v1/twitter/stream/filter-rules/{rule_id} | Delete filter rule |
|
|
14
|
+
| [**twitter_delete_stream_monitor**](TwitterApi.md#twitter_delete_stream_monitor) | **DELETE** /v1/twitter/stream/monitors/{monitor_id} | Delete stream monitor |
|
|
15
|
+
| [**twitter_get_article_by_id**](TwitterApi.md#twitter_get_article_by_id) | **GET** /v1/twitter/tweets/article/{article_id} | Get article by ID |
|
|
16
|
+
| [**twitter_get_broadcast_details**](TwitterApi.md#twitter_get_broadcast_details) | **GET** /v1/twitter/spaces/broadcast/{broadcast_id} | Get broadcast details |
|
|
17
|
+
| [**twitter_get_community_details**](TwitterApi.md#twitter_get_community_details) | **GET** /v1/twitter/communities/{community_id} | Get community details |
|
|
18
|
+
| [**twitter_get_community_notes**](TwitterApi.md#twitter_get_community_notes) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/community_notes | Get community notes |
|
|
19
|
+
| [**twitter_get_community_tweets**](TwitterApi.md#twitter_get_community_tweets) | **GET** /v1/twitter/communities/{community_id}/tweets | Get community tweets |
|
|
20
|
+
| [**twitter_get_filter_rule**](TwitterApi.md#twitter_get_filter_rule) | **GET** /v1/twitter/stream/filter-rules/{rule_id} | Get filter rule |
|
|
21
|
+
| [**twitter_get_filter_rule_per_poll_rates**](TwitterApi.md#twitter_get_filter_rule_per_poll_rates) | **GET** /v1/twitter/stream/filter-rules-pricing | Get filter rule per-poll rates |
|
|
22
|
+
| [**twitter_get_list_details**](TwitterApi.md#twitter_get_list_details) | **GET** /v1/twitter/lists/{list_id}/detail | Get list details |
|
|
23
|
+
| [**twitter_get_list_tweets**](TwitterApi.md#twitter_get_list_tweets) | **GET** /v1/twitter/lists/{list_id}/tweets | Get list tweets |
|
|
24
|
+
| [**twitter_get_place_details**](TwitterApi.md#twitter_get_place_details) | **GET** /v1/twitter/geo/places/{place_id} | Get place details |
|
|
25
|
+
| [**twitter_get_similar_tweets**](TwitterApi.md#twitter_get_similar_tweets) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/similar | Get similar tweets |
|
|
26
|
+
| [**twitter_get_space_details**](TwitterApi.md#twitter_get_space_details) | **GET** /v1/twitter/spaces/{space_id} | Get Space details |
|
|
27
|
+
| [**twitter_get_stream_monitor**](TwitterApi.md#twitter_get_stream_monitor) | **GET** /v1/twitter/stream/monitors/{monitor_id} | Get stream monitor |
|
|
28
|
+
| [**twitter_get_trending_topics**](TwitterApi.md#twitter_get_trending_topics) | **GET** /v1/twitter/trends/ | Get trending topics |
|
|
29
|
+
| [**twitter_get_trends_by_location**](TwitterApi.md#twitter_get_trends_by_location) | **GET** /v1/twitter/trends/place/{woeid} | Get trends by location |
|
|
30
|
+
| [**twitter_get_tweet_details**](TwitterApi.md#twitter_get_tweet_details) | **GET** /v1/twitter/tweets/tweet/{tweet_id} | Get tweet details |
|
|
31
|
+
| [**twitter_get_tweet_edit_history**](TwitterApi.md#twitter_get_tweet_edit_history) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/edit_history | Get tweet edit history |
|
|
32
|
+
| [**twitter_get_tweet_favoriters**](TwitterApi.md#twitter_get_tweet_favoriters) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/favoriters | Get tweet favoriters |
|
|
33
|
+
| [**twitter_get_tweet_quotes**](TwitterApi.md#twitter_get_tweet_quotes) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/quotes | Get tweet quotes |
|
|
34
|
+
| [**twitter_get_tweet_replies**](TwitterApi.md#twitter_get_tweet_replies) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/replies | Get tweet replies |
|
|
35
|
+
| [**twitter_get_tweet_retweeters**](TwitterApi.md#twitter_get_tweet_retweeters) | **GET** /v1/twitter/tweets/tweet/{tweet_id}/retweeters | Get tweet retweeters |
|
|
36
|
+
| [**twitter_get_tweets_by_ids**](TwitterApi.md#twitter_get_tweets_by_ids) | **GET** /v1/twitter/tweets/ | Get tweets by IDs |
|
|
37
|
+
| [**twitter_get_user_articles**](TwitterApi.md#twitter_get_user_articles) | **GET** /v1/twitter/users/{user_id}/articles | Get user articles |
|
|
38
|
+
| [**twitter_get_user_by_id**](TwitterApi.md#twitter_get_user_by_id) | **GET** /v1/twitter/users/{user_id}/by_id | Get user by ID |
|
|
39
|
+
| [**twitter_get_user_by_username**](TwitterApi.md#twitter_get_user_by_username) | **GET** /v1/twitter/users/{username}/by_username | Get user by username |
|
|
40
|
+
| [**twitter_get_user_followers**](TwitterApi.md#twitter_get_user_followers) | **GET** /v1/twitter/users/{username}/followers | Get user followers |
|
|
41
|
+
| [**twitter_get_user_following**](TwitterApi.md#twitter_get_user_following) | **GET** /v1/twitter/users/{username}/followings | Get user following |
|
|
42
|
+
| [**twitter_get_user_mentions**](TwitterApi.md#twitter_get_user_mentions) | **GET** /v1/twitter/users/{username}/mentions | Get user mentions |
|
|
43
|
+
| [**twitter_get_user_subscriptions**](TwitterApi.md#twitter_get_user_subscriptions) | **GET** /v1/twitter/users/{user_id}/subscriptions | Get user subscriptions |
|
|
44
|
+
| [**twitter_get_user_tweets**](TwitterApi.md#twitter_get_user_tweets) | **GET** /v1/twitter/users/{username}/latest_tweets | Get user tweets |
|
|
45
|
+
| [**twitter_list_billing_logs**](TwitterApi.md#twitter_list_billing_logs) | **GET** /v1/twitter/stream/billing-logs | List billing logs |
|
|
46
|
+
| [**twitter_list_delivery_logs_for_a_filter_rule**](TwitterApi.md#twitter_list_delivery_logs_for_a_filter_rule) | **GET** /v1/twitter/stream/filter-rules/{rule_id}/logs | List delivery logs for a filter rule |
|
|
47
|
+
| [**twitter_list_filter_rules**](TwitterApi.md#twitter_list_filter_rules) | **GET** /v1/twitter/stream/filter-rules | List filter rules |
|
|
48
|
+
| [**twitter_list_stream_monitors**](TwitterApi.md#twitter_list_stream_monitors) | **GET** /v1/twitter/stream/monitors | List stream monitors |
|
|
49
|
+
| [**twitter_list_tweet_delivery_logs**](TwitterApi.md#twitter_list_tweet_delivery_logs) | **GET** /v1/twitter/stream/logs | List tweet delivery logs |
|
|
50
|
+
| [**twitter_list_webhooks**](TwitterApi.md#twitter_list_webhooks) | **GET** /v1/twitter/stream/webhooks | List webhooks |
|
|
51
|
+
| [**twitter_remove_webhook_from_monitor**](TwitterApi.md#twitter_remove_webhook_from_monitor) | **DELETE** /v1/twitter/stream/webhooks/{webhook_id} | Remove webhook from monitor |
|
|
52
|
+
| [**twitter_search_communities**](TwitterApi.md#twitter_search_communities) | **GET** /v1/twitter/communities/search | Search communities |
|
|
53
|
+
| [**twitter_search_list_tweets**](TwitterApi.md#twitter_search_list_tweets) | **GET** /v1/twitter/lists/{list_id}/search_tweets | Search list tweets |
|
|
54
|
+
| [**twitter_search_places**](TwitterApi.md#twitter_search_places) | **GET** /v1/twitter/geo/search | Search places |
|
|
55
|
+
| [**twitter_search_users**](TwitterApi.md#twitter_search_users) | **GET** /v1/twitter/users/search_users | Search users |
|
|
56
|
+
| [**twitter_test_webhook_delivery**](TwitterApi.md#twitter_test_webhook_delivery) | **POST** /v1/twitter/stream/webhooks/test | Test webhook delivery |
|
|
57
|
+
| [**twitter_twitter_scraper_health_check**](TwitterApi.md#twitter_twitter_scraper_health_check) | **GET** /v1/twitter/health | Twitter scraper health check |
|
|
58
|
+
| [**twitter_twitter_scraper_health_check_head**](TwitterApi.md#twitter_twitter_scraper_health_check_head) | **HEAD** /v1/twitter/health | Twitter scraper health check |
|
|
59
|
+
| [**twitter_update_filter_rule**](TwitterApi.md#twitter_update_filter_rule) | **PATCH** /v1/twitter/stream/filter-rules/{rule_id} | Update filter rule |
|
|
60
|
+
| [**twitter_update_stream_monitor**](TwitterApi.md#twitter_update_stream_monitor) | **PATCH** /v1/twitter/stream/monitors/{monitor_id} | Update stream monitor |
|
|
61
|
+
| [**twitter_validate_search_query**](TwitterApi.md#twitter_validate_search_query) | **POST** /v1/twitter/stream/filter-rules/validate | Validate search query |
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
## twitter_advanced_tweet_search
|
|
65
|
+
|
|
66
|
+
> Object twitter_advanced_tweet_search(query, opts)
|
|
67
|
+
|
|
68
|
+
Advanced tweet search
|
|
69
|
+
|
|
70
|
+
Search tweets with advanced options.
|
|
71
|
+
|
|
72
|
+
### Examples
|
|
73
|
+
|
|
74
|
+
```ruby
|
|
75
|
+
require 'time'
|
|
76
|
+
require 'scrapebadger'
|
|
77
|
+
# setup authorization
|
|
78
|
+
ScrapeBadger.configure do |config|
|
|
79
|
+
# Configure API key authorization: ApiKeyAuth
|
|
80
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
82
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
86
|
+
query = 'query_example' # String |
|
|
87
|
+
opts = {
|
|
88
|
+
query_type: 'query_type_example', # String |
|
|
89
|
+
count: 56, # Integer |
|
|
90
|
+
cursor: 'cursor_example' # String |
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
begin
|
|
94
|
+
# Advanced tweet search
|
|
95
|
+
result = api_instance.twitter_advanced_tweet_search(query, opts)
|
|
96
|
+
p result
|
|
97
|
+
rescue ScrapeBadger::ApiError => e
|
|
98
|
+
puts "Error when calling TwitterApi->twitter_advanced_tweet_search: #{e}"
|
|
99
|
+
end
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
#### Using the twitter_advanced_tweet_search_with_http_info variant
|
|
103
|
+
|
|
104
|
+
This returns an Array which contains the response data, status code and headers.
|
|
105
|
+
|
|
106
|
+
> <Array(Object, Integer, Hash)> twitter_advanced_tweet_search_with_http_info(query, opts)
|
|
107
|
+
|
|
108
|
+
```ruby
|
|
109
|
+
begin
|
|
110
|
+
# Advanced tweet search
|
|
111
|
+
data, status_code, headers = api_instance.twitter_advanced_tweet_search_with_http_info(query, opts)
|
|
112
|
+
p status_code # => 2xx
|
|
113
|
+
p headers # => { ... }
|
|
114
|
+
p data # => Object
|
|
115
|
+
rescue ScrapeBadger::ApiError => e
|
|
116
|
+
puts "Error when calling TwitterApi->twitter_advanced_tweet_search_with_http_info: #{e}"
|
|
117
|
+
end
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Parameters
|
|
121
|
+
|
|
122
|
+
| Name | Type | Description | Notes |
|
|
123
|
+
| ---- | ---- | ----------- | ----- |
|
|
124
|
+
| **query** | **String** | | |
|
|
125
|
+
| **query_type** | **String** | | [optional] |
|
|
126
|
+
| **count** | **Integer** | | [optional] |
|
|
127
|
+
| **cursor** | **String** | | [optional] |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**Object**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
## twitter_batch_get_users_by_ids
|
|
144
|
+
|
|
145
|
+
> Object twitter_batch_get_users_by_ids(user_ids)
|
|
146
|
+
|
|
147
|
+
Batch get users by IDs
|
|
148
|
+
|
|
149
|
+
Get multiple user profiles by their numeric IDs (comma-separated).
|
|
150
|
+
|
|
151
|
+
### Examples
|
|
152
|
+
|
|
153
|
+
```ruby
|
|
154
|
+
require 'time'
|
|
155
|
+
require 'scrapebadger'
|
|
156
|
+
# setup authorization
|
|
157
|
+
ScrapeBadger.configure do |config|
|
|
158
|
+
# Configure API key authorization: ApiKeyAuth
|
|
159
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
161
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
165
|
+
user_ids = 'user_ids_example' # String |
|
|
166
|
+
|
|
167
|
+
begin
|
|
168
|
+
# Batch get users by IDs
|
|
169
|
+
result = api_instance.twitter_batch_get_users_by_ids(user_ids)
|
|
170
|
+
p result
|
|
171
|
+
rescue ScrapeBadger::ApiError => e
|
|
172
|
+
puts "Error when calling TwitterApi->twitter_batch_get_users_by_ids: #{e}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### Using the twitter_batch_get_users_by_ids_with_http_info variant
|
|
177
|
+
|
|
178
|
+
This returns an Array which contains the response data, status code and headers.
|
|
179
|
+
|
|
180
|
+
> <Array(Object, Integer, Hash)> twitter_batch_get_users_by_ids_with_http_info(user_ids)
|
|
181
|
+
|
|
182
|
+
```ruby
|
|
183
|
+
begin
|
|
184
|
+
# Batch get users by IDs
|
|
185
|
+
data, status_code, headers = api_instance.twitter_batch_get_users_by_ids_with_http_info(user_ids)
|
|
186
|
+
p status_code # => 2xx
|
|
187
|
+
p headers # => { ... }
|
|
188
|
+
p data # => Object
|
|
189
|
+
rescue ScrapeBadger::ApiError => e
|
|
190
|
+
puts "Error when calling TwitterApi->twitter_batch_get_users_by_ids_with_http_info: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
| Name | Type | Description | Notes |
|
|
197
|
+
| ---- | ---- | ----------- | ----- |
|
|
198
|
+
| **user_ids** | **String** | | |
|
|
199
|
+
|
|
200
|
+
### Return type
|
|
201
|
+
|
|
202
|
+
**Object**
|
|
203
|
+
|
|
204
|
+
### Authorization
|
|
205
|
+
|
|
206
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
207
|
+
|
|
208
|
+
### HTTP request headers
|
|
209
|
+
|
|
210
|
+
- **Content-Type**: Not defined
|
|
211
|
+
- **Accept**: application/json
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
## twitter_batch_get_users_by_usernames
|
|
215
|
+
|
|
216
|
+
> Object twitter_batch_get_users_by_usernames(usernames)
|
|
217
|
+
|
|
218
|
+
Batch get users by usernames
|
|
219
|
+
|
|
220
|
+
Get multiple user profiles by their usernames (comma-separated).
|
|
221
|
+
|
|
222
|
+
### Examples
|
|
223
|
+
|
|
224
|
+
```ruby
|
|
225
|
+
require 'time'
|
|
226
|
+
require 'scrapebadger'
|
|
227
|
+
# setup authorization
|
|
228
|
+
ScrapeBadger.configure do |config|
|
|
229
|
+
# Configure API key authorization: ApiKeyAuth
|
|
230
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
231
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
232
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
236
|
+
usernames = 'usernames_example' # String |
|
|
237
|
+
|
|
238
|
+
begin
|
|
239
|
+
# Batch get users by usernames
|
|
240
|
+
result = api_instance.twitter_batch_get_users_by_usernames(usernames)
|
|
241
|
+
p result
|
|
242
|
+
rescue ScrapeBadger::ApiError => e
|
|
243
|
+
puts "Error when calling TwitterApi->twitter_batch_get_users_by_usernames: #{e}"
|
|
244
|
+
end
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
#### Using the twitter_batch_get_users_by_usernames_with_http_info variant
|
|
248
|
+
|
|
249
|
+
This returns an Array which contains the response data, status code and headers.
|
|
250
|
+
|
|
251
|
+
> <Array(Object, Integer, Hash)> twitter_batch_get_users_by_usernames_with_http_info(usernames)
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
begin
|
|
255
|
+
# Batch get users by usernames
|
|
256
|
+
data, status_code, headers = api_instance.twitter_batch_get_users_by_usernames_with_http_info(usernames)
|
|
257
|
+
p status_code # => 2xx
|
|
258
|
+
p headers # => { ... }
|
|
259
|
+
p data # => Object
|
|
260
|
+
rescue ScrapeBadger::ApiError => e
|
|
261
|
+
puts "Error when calling TwitterApi->twitter_batch_get_users_by_usernames_with_http_info: #{e}"
|
|
262
|
+
end
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Parameters
|
|
266
|
+
|
|
267
|
+
| Name | Type | Description | Notes |
|
|
268
|
+
| ---- | ---- | ----------- | ----- |
|
|
269
|
+
| **usernames** | **String** | | |
|
|
270
|
+
|
|
271
|
+
### Return type
|
|
272
|
+
|
|
273
|
+
**Object**
|
|
274
|
+
|
|
275
|
+
### Authorization
|
|
276
|
+
|
|
277
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
278
|
+
|
|
279
|
+
### HTTP request headers
|
|
280
|
+
|
|
281
|
+
- **Content-Type**: Not defined
|
|
282
|
+
- **Accept**: application/json
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
## twitter_configure_webhook_on_a_monitor
|
|
286
|
+
|
|
287
|
+
> <WebhookResponse> twitter_configure_webhook_on_a_monitor(webhook_create)
|
|
288
|
+
|
|
289
|
+
Configure webhook on a monitor
|
|
290
|
+
|
|
291
|
+
Configure a webhook delivery URL on a stream monitor. The secret is returned only once on creation. Subsequent calls show secret_set: bool. If monitor already has a webhook, delete it first (409 is returned).
|
|
292
|
+
|
|
293
|
+
### Examples
|
|
294
|
+
|
|
295
|
+
```ruby
|
|
296
|
+
require 'time'
|
|
297
|
+
require 'scrapebadger'
|
|
298
|
+
# setup authorization
|
|
299
|
+
ScrapeBadger.configure do |config|
|
|
300
|
+
# Configure API key authorization: ApiKeyAuth
|
|
301
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
302
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
303
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
307
|
+
webhook_create = ScrapeBadger::WebhookCreate.new({monitor_id: 'monitor_id_example', url: 'url_example'}) # WebhookCreate |
|
|
308
|
+
|
|
309
|
+
begin
|
|
310
|
+
# Configure webhook on a monitor
|
|
311
|
+
result = api_instance.twitter_configure_webhook_on_a_monitor(webhook_create)
|
|
312
|
+
p result
|
|
313
|
+
rescue ScrapeBadger::ApiError => e
|
|
314
|
+
puts "Error when calling TwitterApi->twitter_configure_webhook_on_a_monitor: #{e}"
|
|
315
|
+
end
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
#### Using the twitter_configure_webhook_on_a_monitor_with_http_info variant
|
|
319
|
+
|
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
|
321
|
+
|
|
322
|
+
> <Array(<WebhookResponse>, Integer, Hash)> twitter_configure_webhook_on_a_monitor_with_http_info(webhook_create)
|
|
323
|
+
|
|
324
|
+
```ruby
|
|
325
|
+
begin
|
|
326
|
+
# Configure webhook on a monitor
|
|
327
|
+
data, status_code, headers = api_instance.twitter_configure_webhook_on_a_monitor_with_http_info(webhook_create)
|
|
328
|
+
p status_code # => 2xx
|
|
329
|
+
p headers # => { ... }
|
|
330
|
+
p data # => <WebhookResponse>
|
|
331
|
+
rescue ScrapeBadger::ApiError => e
|
|
332
|
+
puts "Error when calling TwitterApi->twitter_configure_webhook_on_a_monitor_with_http_info: #{e}"
|
|
333
|
+
end
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
| Name | Type | Description | Notes |
|
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
|
340
|
+
| **webhook_create** | [**WebhookCreate**](WebhookCreate.md) | | |
|
|
341
|
+
|
|
342
|
+
### Return type
|
|
343
|
+
|
|
344
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
345
|
+
|
|
346
|
+
### Authorization
|
|
347
|
+
|
|
348
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
349
|
+
|
|
350
|
+
### HTTP request headers
|
|
351
|
+
|
|
352
|
+
- **Content-Type**: application/json
|
|
353
|
+
- **Accept**: application/json
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
## twitter_create_filter_rule
|
|
357
|
+
|
|
358
|
+
> <FilterRuleResponse> twitter_create_filter_rule(filter_rule_create)
|
|
359
|
+
|
|
360
|
+
Create filter rule
|
|
361
|
+
|
|
362
|
+
Create a new query-based tweet filter rule. The rule starts in 'active' status immediately. Credits must be positive. The (api_key_id, tag) pair must be unique.
|
|
363
|
+
|
|
364
|
+
### Examples
|
|
365
|
+
|
|
366
|
+
```ruby
|
|
367
|
+
require 'time'
|
|
368
|
+
require 'scrapebadger'
|
|
369
|
+
# setup authorization
|
|
370
|
+
ScrapeBadger.configure do |config|
|
|
371
|
+
# Configure API key authorization: ApiKeyAuth
|
|
372
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
373
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
374
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
378
|
+
filter_rule_create = ScrapeBadger::FilterRuleCreate.new({tag: 'tag_example', query: 'query_example', interval_seconds: 3.56}) # FilterRuleCreate |
|
|
379
|
+
|
|
380
|
+
begin
|
|
381
|
+
# Create filter rule
|
|
382
|
+
result = api_instance.twitter_create_filter_rule(filter_rule_create)
|
|
383
|
+
p result
|
|
384
|
+
rescue ScrapeBadger::ApiError => e
|
|
385
|
+
puts "Error when calling TwitterApi->twitter_create_filter_rule: #{e}"
|
|
386
|
+
end
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
#### Using the twitter_create_filter_rule_with_http_info variant
|
|
390
|
+
|
|
391
|
+
This returns an Array which contains the response data, status code and headers.
|
|
392
|
+
|
|
393
|
+
> <Array(<FilterRuleResponse>, Integer, Hash)> twitter_create_filter_rule_with_http_info(filter_rule_create)
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
begin
|
|
397
|
+
# Create filter rule
|
|
398
|
+
data, status_code, headers = api_instance.twitter_create_filter_rule_with_http_info(filter_rule_create)
|
|
399
|
+
p status_code # => 2xx
|
|
400
|
+
p headers # => { ... }
|
|
401
|
+
p data # => <FilterRuleResponse>
|
|
402
|
+
rescue ScrapeBadger::ApiError => e
|
|
403
|
+
puts "Error when calling TwitterApi->twitter_create_filter_rule_with_http_info: #{e}"
|
|
404
|
+
end
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
### Parameters
|
|
408
|
+
|
|
409
|
+
| Name | Type | Description | Notes |
|
|
410
|
+
| ---- | ---- | ----------- | ----- |
|
|
411
|
+
| **filter_rule_create** | [**FilterRuleCreate**](FilterRuleCreate.md) | | |
|
|
412
|
+
|
|
413
|
+
### Return type
|
|
414
|
+
|
|
415
|
+
[**FilterRuleResponse**](FilterRuleResponse.md)
|
|
416
|
+
|
|
417
|
+
### Authorization
|
|
418
|
+
|
|
419
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
420
|
+
|
|
421
|
+
### HTTP request headers
|
|
422
|
+
|
|
423
|
+
- **Content-Type**: application/json
|
|
424
|
+
- **Accept**: application/json
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
## twitter_create_stream_monitor
|
|
428
|
+
|
|
429
|
+
> <StreamMonitorResponse> twitter_create_stream_monitor(stream_monitor_create)
|
|
430
|
+
|
|
431
|
+
Create stream monitor
|
|
432
|
+
|
|
433
|
+
Create a new stream monitor to watch Twitter accounts in real-time.
|
|
434
|
+
|
|
435
|
+
### Examples
|
|
436
|
+
|
|
437
|
+
```ruby
|
|
438
|
+
require 'time'
|
|
439
|
+
require 'scrapebadger'
|
|
440
|
+
# setup authorization
|
|
441
|
+
ScrapeBadger.configure do |config|
|
|
442
|
+
# Configure API key authorization: ApiKeyAuth
|
|
443
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
444
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
445
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
449
|
+
stream_monitor_create = ScrapeBadger::StreamMonitorCreate.new({name: 'name_example', usernames: ['usernames_example']}) # StreamMonitorCreate |
|
|
450
|
+
|
|
451
|
+
begin
|
|
452
|
+
# Create stream monitor
|
|
453
|
+
result = api_instance.twitter_create_stream_monitor(stream_monitor_create)
|
|
454
|
+
p result
|
|
455
|
+
rescue ScrapeBadger::ApiError => e
|
|
456
|
+
puts "Error when calling TwitterApi->twitter_create_stream_monitor: #{e}"
|
|
457
|
+
end
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
#### Using the twitter_create_stream_monitor_with_http_info variant
|
|
461
|
+
|
|
462
|
+
This returns an Array which contains the response data, status code and headers.
|
|
463
|
+
|
|
464
|
+
> <Array(<StreamMonitorResponse>, Integer, Hash)> twitter_create_stream_monitor_with_http_info(stream_monitor_create)
|
|
465
|
+
|
|
466
|
+
```ruby
|
|
467
|
+
begin
|
|
468
|
+
# Create stream monitor
|
|
469
|
+
data, status_code, headers = api_instance.twitter_create_stream_monitor_with_http_info(stream_monitor_create)
|
|
470
|
+
p status_code # => 2xx
|
|
471
|
+
p headers # => { ... }
|
|
472
|
+
p data # => <StreamMonitorResponse>
|
|
473
|
+
rescue ScrapeBadger::ApiError => e
|
|
474
|
+
puts "Error when calling TwitterApi->twitter_create_stream_monitor_with_http_info: #{e}"
|
|
475
|
+
end
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
### Parameters
|
|
479
|
+
|
|
480
|
+
| Name | Type | Description | Notes |
|
|
481
|
+
| ---- | ---- | ----------- | ----- |
|
|
482
|
+
| **stream_monitor_create** | [**StreamMonitorCreate**](StreamMonitorCreate.md) | | |
|
|
483
|
+
|
|
484
|
+
### Return type
|
|
485
|
+
|
|
486
|
+
[**StreamMonitorResponse**](StreamMonitorResponse.md)
|
|
487
|
+
|
|
488
|
+
### Authorization
|
|
489
|
+
|
|
490
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
491
|
+
|
|
492
|
+
### HTTP request headers
|
|
493
|
+
|
|
494
|
+
- **Content-Type**: application/json
|
|
495
|
+
- **Accept**: application/json
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
## twitter_delete_filter_rule
|
|
499
|
+
|
|
500
|
+
> twitter_delete_filter_rule(rule_id)
|
|
501
|
+
|
|
502
|
+
Delete filter rule
|
|
503
|
+
|
|
504
|
+
Delete a filter rule and all its logs.
|
|
505
|
+
|
|
506
|
+
### Examples
|
|
507
|
+
|
|
508
|
+
```ruby
|
|
509
|
+
require 'time'
|
|
510
|
+
require 'scrapebadger'
|
|
511
|
+
# setup authorization
|
|
512
|
+
ScrapeBadger.configure do |config|
|
|
513
|
+
# Configure API key authorization: ApiKeyAuth
|
|
514
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
516
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
520
|
+
rule_id = 'rule_id_example' # String |
|
|
521
|
+
|
|
522
|
+
begin
|
|
523
|
+
# Delete filter rule
|
|
524
|
+
api_instance.twitter_delete_filter_rule(rule_id)
|
|
525
|
+
rescue ScrapeBadger::ApiError => e
|
|
526
|
+
puts "Error when calling TwitterApi->twitter_delete_filter_rule: #{e}"
|
|
527
|
+
end
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
#### Using the twitter_delete_filter_rule_with_http_info variant
|
|
531
|
+
|
|
532
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
533
|
+
|
|
534
|
+
> <Array(nil, Integer, Hash)> twitter_delete_filter_rule_with_http_info(rule_id)
|
|
535
|
+
|
|
536
|
+
```ruby
|
|
537
|
+
begin
|
|
538
|
+
# Delete filter rule
|
|
539
|
+
data, status_code, headers = api_instance.twitter_delete_filter_rule_with_http_info(rule_id)
|
|
540
|
+
p status_code # => 2xx
|
|
541
|
+
p headers # => { ... }
|
|
542
|
+
p data # => nil
|
|
543
|
+
rescue ScrapeBadger::ApiError => e
|
|
544
|
+
puts "Error when calling TwitterApi->twitter_delete_filter_rule_with_http_info: #{e}"
|
|
545
|
+
end
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
### Parameters
|
|
549
|
+
|
|
550
|
+
| Name | Type | Description | Notes |
|
|
551
|
+
| ---- | ---- | ----------- | ----- |
|
|
552
|
+
| **rule_id** | **String** | | |
|
|
553
|
+
|
|
554
|
+
### Return type
|
|
555
|
+
|
|
556
|
+
nil (empty response body)
|
|
557
|
+
|
|
558
|
+
### Authorization
|
|
559
|
+
|
|
560
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
561
|
+
|
|
562
|
+
### HTTP request headers
|
|
563
|
+
|
|
564
|
+
- **Content-Type**: Not defined
|
|
565
|
+
- **Accept**: application/json
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
## twitter_delete_stream_monitor
|
|
569
|
+
|
|
570
|
+
> twitter_delete_stream_monitor(monitor_id)
|
|
571
|
+
|
|
572
|
+
Delete stream monitor
|
|
573
|
+
|
|
574
|
+
Delete a stream monitor and all its logs.
|
|
575
|
+
|
|
576
|
+
### Examples
|
|
577
|
+
|
|
578
|
+
```ruby
|
|
579
|
+
require 'time'
|
|
580
|
+
require 'scrapebadger'
|
|
581
|
+
# setup authorization
|
|
582
|
+
ScrapeBadger.configure do |config|
|
|
583
|
+
# Configure API key authorization: ApiKeyAuth
|
|
584
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
585
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
586
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
587
|
+
end
|
|
588
|
+
|
|
589
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
590
|
+
monitor_id = 'monitor_id_example' # String |
|
|
591
|
+
|
|
592
|
+
begin
|
|
593
|
+
# Delete stream monitor
|
|
594
|
+
api_instance.twitter_delete_stream_monitor(monitor_id)
|
|
595
|
+
rescue ScrapeBadger::ApiError => e
|
|
596
|
+
puts "Error when calling TwitterApi->twitter_delete_stream_monitor: #{e}"
|
|
597
|
+
end
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
#### Using the twitter_delete_stream_monitor_with_http_info variant
|
|
601
|
+
|
|
602
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
603
|
+
|
|
604
|
+
> <Array(nil, Integer, Hash)> twitter_delete_stream_monitor_with_http_info(monitor_id)
|
|
605
|
+
|
|
606
|
+
```ruby
|
|
607
|
+
begin
|
|
608
|
+
# Delete stream monitor
|
|
609
|
+
data, status_code, headers = api_instance.twitter_delete_stream_monitor_with_http_info(monitor_id)
|
|
610
|
+
p status_code # => 2xx
|
|
611
|
+
p headers # => { ... }
|
|
612
|
+
p data # => nil
|
|
613
|
+
rescue ScrapeBadger::ApiError => e
|
|
614
|
+
puts "Error when calling TwitterApi->twitter_delete_stream_monitor_with_http_info: #{e}"
|
|
615
|
+
end
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
### Parameters
|
|
619
|
+
|
|
620
|
+
| Name | Type | Description | Notes |
|
|
621
|
+
| ---- | ---- | ----------- | ----- |
|
|
622
|
+
| **monitor_id** | **String** | | |
|
|
623
|
+
|
|
624
|
+
### Return type
|
|
625
|
+
|
|
626
|
+
nil (empty response body)
|
|
627
|
+
|
|
628
|
+
### Authorization
|
|
629
|
+
|
|
630
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
631
|
+
|
|
632
|
+
### HTTP request headers
|
|
633
|
+
|
|
634
|
+
- **Content-Type**: Not defined
|
|
635
|
+
- **Accept**: application/json
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
## twitter_get_article_by_id
|
|
639
|
+
|
|
640
|
+
> Object twitter_get_article_by_id(article_id)
|
|
641
|
+
|
|
642
|
+
Get article by ID
|
|
643
|
+
|
|
644
|
+
Get a long-form article by its ID.
|
|
645
|
+
|
|
646
|
+
### Examples
|
|
647
|
+
|
|
648
|
+
```ruby
|
|
649
|
+
require 'time'
|
|
650
|
+
require 'scrapebadger'
|
|
651
|
+
# setup authorization
|
|
652
|
+
ScrapeBadger.configure do |config|
|
|
653
|
+
# Configure API key authorization: ApiKeyAuth
|
|
654
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
655
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
656
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
660
|
+
article_id = 'article_id_example' # String |
|
|
661
|
+
|
|
662
|
+
begin
|
|
663
|
+
# Get article by ID
|
|
664
|
+
result = api_instance.twitter_get_article_by_id(article_id)
|
|
665
|
+
p result
|
|
666
|
+
rescue ScrapeBadger::ApiError => e
|
|
667
|
+
puts "Error when calling TwitterApi->twitter_get_article_by_id: #{e}"
|
|
668
|
+
end
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
#### Using the twitter_get_article_by_id_with_http_info variant
|
|
672
|
+
|
|
673
|
+
This returns an Array which contains the response data, status code and headers.
|
|
674
|
+
|
|
675
|
+
> <Array(Object, Integer, Hash)> twitter_get_article_by_id_with_http_info(article_id)
|
|
676
|
+
|
|
677
|
+
```ruby
|
|
678
|
+
begin
|
|
679
|
+
# Get article by ID
|
|
680
|
+
data, status_code, headers = api_instance.twitter_get_article_by_id_with_http_info(article_id)
|
|
681
|
+
p status_code # => 2xx
|
|
682
|
+
p headers # => { ... }
|
|
683
|
+
p data # => Object
|
|
684
|
+
rescue ScrapeBadger::ApiError => e
|
|
685
|
+
puts "Error when calling TwitterApi->twitter_get_article_by_id_with_http_info: #{e}"
|
|
686
|
+
end
|
|
687
|
+
```
|
|
688
|
+
|
|
689
|
+
### Parameters
|
|
690
|
+
|
|
691
|
+
| Name | Type | Description | Notes |
|
|
692
|
+
| ---- | ---- | ----------- | ----- |
|
|
693
|
+
| **article_id** | **String** | | |
|
|
694
|
+
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
**Object**
|
|
698
|
+
|
|
699
|
+
### Authorization
|
|
700
|
+
|
|
701
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
702
|
+
|
|
703
|
+
### HTTP request headers
|
|
704
|
+
|
|
705
|
+
- **Content-Type**: Not defined
|
|
706
|
+
- **Accept**: application/json
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
## twitter_get_broadcast_details
|
|
710
|
+
|
|
711
|
+
> Object twitter_get_broadcast_details(broadcast_id)
|
|
712
|
+
|
|
713
|
+
Get broadcast details
|
|
714
|
+
|
|
715
|
+
Get details of a live video broadcast.
|
|
716
|
+
|
|
717
|
+
### Examples
|
|
718
|
+
|
|
719
|
+
```ruby
|
|
720
|
+
require 'time'
|
|
721
|
+
require 'scrapebadger'
|
|
722
|
+
# setup authorization
|
|
723
|
+
ScrapeBadger.configure do |config|
|
|
724
|
+
# Configure API key authorization: ApiKeyAuth
|
|
725
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
726
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
727
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
728
|
+
end
|
|
729
|
+
|
|
730
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
731
|
+
broadcast_id = 'broadcast_id_example' # String |
|
|
732
|
+
|
|
733
|
+
begin
|
|
734
|
+
# Get broadcast details
|
|
735
|
+
result = api_instance.twitter_get_broadcast_details(broadcast_id)
|
|
736
|
+
p result
|
|
737
|
+
rescue ScrapeBadger::ApiError => e
|
|
738
|
+
puts "Error when calling TwitterApi->twitter_get_broadcast_details: #{e}"
|
|
739
|
+
end
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
#### Using the twitter_get_broadcast_details_with_http_info variant
|
|
743
|
+
|
|
744
|
+
This returns an Array which contains the response data, status code and headers.
|
|
745
|
+
|
|
746
|
+
> <Array(Object, Integer, Hash)> twitter_get_broadcast_details_with_http_info(broadcast_id)
|
|
747
|
+
|
|
748
|
+
```ruby
|
|
749
|
+
begin
|
|
750
|
+
# Get broadcast details
|
|
751
|
+
data, status_code, headers = api_instance.twitter_get_broadcast_details_with_http_info(broadcast_id)
|
|
752
|
+
p status_code # => 2xx
|
|
753
|
+
p headers # => { ... }
|
|
754
|
+
p data # => Object
|
|
755
|
+
rescue ScrapeBadger::ApiError => e
|
|
756
|
+
puts "Error when calling TwitterApi->twitter_get_broadcast_details_with_http_info: #{e}"
|
|
757
|
+
end
|
|
758
|
+
```
|
|
759
|
+
|
|
760
|
+
### Parameters
|
|
761
|
+
|
|
762
|
+
| Name | Type | Description | Notes |
|
|
763
|
+
| ---- | ---- | ----------- | ----- |
|
|
764
|
+
| **broadcast_id** | **String** | | |
|
|
765
|
+
|
|
766
|
+
### Return type
|
|
767
|
+
|
|
768
|
+
**Object**
|
|
769
|
+
|
|
770
|
+
### Authorization
|
|
771
|
+
|
|
772
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
773
|
+
|
|
774
|
+
### HTTP request headers
|
|
775
|
+
|
|
776
|
+
- **Content-Type**: Not defined
|
|
777
|
+
- **Accept**: application/json
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
## twitter_get_community_details
|
|
781
|
+
|
|
782
|
+
> Object twitter_get_community_details(community_id)
|
|
783
|
+
|
|
784
|
+
Get community details
|
|
785
|
+
|
|
786
|
+
Get details of a specific community.
|
|
787
|
+
|
|
788
|
+
### Examples
|
|
789
|
+
|
|
790
|
+
```ruby
|
|
791
|
+
require 'time'
|
|
792
|
+
require 'scrapebadger'
|
|
793
|
+
# setup authorization
|
|
794
|
+
ScrapeBadger.configure do |config|
|
|
795
|
+
# Configure API key authorization: ApiKeyAuth
|
|
796
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
797
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
798
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
799
|
+
end
|
|
800
|
+
|
|
801
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
802
|
+
community_id = 'community_id_example' # String |
|
|
803
|
+
|
|
804
|
+
begin
|
|
805
|
+
# Get community details
|
|
806
|
+
result = api_instance.twitter_get_community_details(community_id)
|
|
807
|
+
p result
|
|
808
|
+
rescue ScrapeBadger::ApiError => e
|
|
809
|
+
puts "Error when calling TwitterApi->twitter_get_community_details: #{e}"
|
|
810
|
+
end
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
#### Using the twitter_get_community_details_with_http_info variant
|
|
814
|
+
|
|
815
|
+
This returns an Array which contains the response data, status code and headers.
|
|
816
|
+
|
|
817
|
+
> <Array(Object, Integer, Hash)> twitter_get_community_details_with_http_info(community_id)
|
|
818
|
+
|
|
819
|
+
```ruby
|
|
820
|
+
begin
|
|
821
|
+
# Get community details
|
|
822
|
+
data, status_code, headers = api_instance.twitter_get_community_details_with_http_info(community_id)
|
|
823
|
+
p status_code # => 2xx
|
|
824
|
+
p headers # => { ... }
|
|
825
|
+
p data # => Object
|
|
826
|
+
rescue ScrapeBadger::ApiError => e
|
|
827
|
+
puts "Error when calling TwitterApi->twitter_get_community_details_with_http_info: #{e}"
|
|
828
|
+
end
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
### Parameters
|
|
832
|
+
|
|
833
|
+
| Name | Type | Description | Notes |
|
|
834
|
+
| ---- | ---- | ----------- | ----- |
|
|
835
|
+
| **community_id** | **String** | | |
|
|
836
|
+
|
|
837
|
+
### Return type
|
|
838
|
+
|
|
839
|
+
**Object**
|
|
840
|
+
|
|
841
|
+
### Authorization
|
|
842
|
+
|
|
843
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
844
|
+
|
|
845
|
+
### HTTP request headers
|
|
846
|
+
|
|
847
|
+
- **Content-Type**: Not defined
|
|
848
|
+
- **Accept**: application/json
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
## twitter_get_community_notes
|
|
852
|
+
|
|
853
|
+
> Object twitter_get_community_notes(tweet_id)
|
|
854
|
+
|
|
855
|
+
Get community notes
|
|
856
|
+
|
|
857
|
+
Get community notes (Birdwatch) for a specific tweet.
|
|
858
|
+
|
|
859
|
+
### Examples
|
|
860
|
+
|
|
861
|
+
```ruby
|
|
862
|
+
require 'time'
|
|
863
|
+
require 'scrapebadger'
|
|
864
|
+
# setup authorization
|
|
865
|
+
ScrapeBadger.configure do |config|
|
|
866
|
+
# Configure API key authorization: ApiKeyAuth
|
|
867
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
868
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
869
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
870
|
+
end
|
|
871
|
+
|
|
872
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
873
|
+
tweet_id = 'tweet_id_example' # String |
|
|
874
|
+
|
|
875
|
+
begin
|
|
876
|
+
# Get community notes
|
|
877
|
+
result = api_instance.twitter_get_community_notes(tweet_id)
|
|
878
|
+
p result
|
|
879
|
+
rescue ScrapeBadger::ApiError => e
|
|
880
|
+
puts "Error when calling TwitterApi->twitter_get_community_notes: #{e}"
|
|
881
|
+
end
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
#### Using the twitter_get_community_notes_with_http_info variant
|
|
885
|
+
|
|
886
|
+
This returns an Array which contains the response data, status code and headers.
|
|
887
|
+
|
|
888
|
+
> <Array(Object, Integer, Hash)> twitter_get_community_notes_with_http_info(tweet_id)
|
|
889
|
+
|
|
890
|
+
```ruby
|
|
891
|
+
begin
|
|
892
|
+
# Get community notes
|
|
893
|
+
data, status_code, headers = api_instance.twitter_get_community_notes_with_http_info(tweet_id)
|
|
894
|
+
p status_code # => 2xx
|
|
895
|
+
p headers # => { ... }
|
|
896
|
+
p data # => Object
|
|
897
|
+
rescue ScrapeBadger::ApiError => e
|
|
898
|
+
puts "Error when calling TwitterApi->twitter_get_community_notes_with_http_info: #{e}"
|
|
899
|
+
end
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
### Parameters
|
|
903
|
+
|
|
904
|
+
| Name | Type | Description | Notes |
|
|
905
|
+
| ---- | ---- | ----------- | ----- |
|
|
906
|
+
| **tweet_id** | **String** | | |
|
|
907
|
+
|
|
908
|
+
### Return type
|
|
909
|
+
|
|
910
|
+
**Object**
|
|
911
|
+
|
|
912
|
+
### Authorization
|
|
913
|
+
|
|
914
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
915
|
+
|
|
916
|
+
### HTTP request headers
|
|
917
|
+
|
|
918
|
+
- **Content-Type**: Not defined
|
|
919
|
+
- **Accept**: application/json
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
## twitter_get_community_tweets
|
|
923
|
+
|
|
924
|
+
> Object twitter_get_community_tweets(community_id, opts)
|
|
925
|
+
|
|
926
|
+
Get community tweets
|
|
927
|
+
|
|
928
|
+
Get tweets from a specific community.
|
|
929
|
+
|
|
930
|
+
### Examples
|
|
931
|
+
|
|
932
|
+
```ruby
|
|
933
|
+
require 'time'
|
|
934
|
+
require 'scrapebadger'
|
|
935
|
+
# setup authorization
|
|
936
|
+
ScrapeBadger.configure do |config|
|
|
937
|
+
# Configure API key authorization: ApiKeyAuth
|
|
938
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
939
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
940
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
941
|
+
end
|
|
942
|
+
|
|
943
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
944
|
+
community_id = 'community_id_example' # String |
|
|
945
|
+
opts = {
|
|
946
|
+
tweet_type: 'tweet_type_example', # String |
|
|
947
|
+
cursor: 'cursor_example' # String |
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
begin
|
|
951
|
+
# Get community tweets
|
|
952
|
+
result = api_instance.twitter_get_community_tweets(community_id, opts)
|
|
953
|
+
p result
|
|
954
|
+
rescue ScrapeBadger::ApiError => e
|
|
955
|
+
puts "Error when calling TwitterApi->twitter_get_community_tweets: #{e}"
|
|
956
|
+
end
|
|
957
|
+
```
|
|
958
|
+
|
|
959
|
+
#### Using the twitter_get_community_tweets_with_http_info variant
|
|
960
|
+
|
|
961
|
+
This returns an Array which contains the response data, status code and headers.
|
|
962
|
+
|
|
963
|
+
> <Array(Object, Integer, Hash)> twitter_get_community_tweets_with_http_info(community_id, opts)
|
|
964
|
+
|
|
965
|
+
```ruby
|
|
966
|
+
begin
|
|
967
|
+
# Get community tweets
|
|
968
|
+
data, status_code, headers = api_instance.twitter_get_community_tweets_with_http_info(community_id, opts)
|
|
969
|
+
p status_code # => 2xx
|
|
970
|
+
p headers # => { ... }
|
|
971
|
+
p data # => Object
|
|
972
|
+
rescue ScrapeBadger::ApiError => e
|
|
973
|
+
puts "Error when calling TwitterApi->twitter_get_community_tweets_with_http_info: #{e}"
|
|
974
|
+
end
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
### Parameters
|
|
978
|
+
|
|
979
|
+
| Name | Type | Description | Notes |
|
|
980
|
+
| ---- | ---- | ----------- | ----- |
|
|
981
|
+
| **community_id** | **String** | | |
|
|
982
|
+
| **tweet_type** | **String** | | [optional] |
|
|
983
|
+
| **cursor** | **String** | | [optional] |
|
|
984
|
+
|
|
985
|
+
### Return type
|
|
986
|
+
|
|
987
|
+
**Object**
|
|
988
|
+
|
|
989
|
+
### Authorization
|
|
990
|
+
|
|
991
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
992
|
+
|
|
993
|
+
### HTTP request headers
|
|
994
|
+
|
|
995
|
+
- **Content-Type**: Not defined
|
|
996
|
+
- **Accept**: application/json
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
## twitter_get_filter_rule
|
|
1000
|
+
|
|
1001
|
+
> <FilterRuleResponse> twitter_get_filter_rule(rule_id)
|
|
1002
|
+
|
|
1003
|
+
Get filter rule
|
|
1004
|
+
|
|
1005
|
+
Get a single filter rule by ID.
|
|
1006
|
+
|
|
1007
|
+
### Examples
|
|
1008
|
+
|
|
1009
|
+
```ruby
|
|
1010
|
+
require 'time'
|
|
1011
|
+
require 'scrapebadger'
|
|
1012
|
+
# setup authorization
|
|
1013
|
+
ScrapeBadger.configure do |config|
|
|
1014
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1015
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1016
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1017
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1018
|
+
end
|
|
1019
|
+
|
|
1020
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1021
|
+
rule_id = 'rule_id_example' # String |
|
|
1022
|
+
|
|
1023
|
+
begin
|
|
1024
|
+
# Get filter rule
|
|
1025
|
+
result = api_instance.twitter_get_filter_rule(rule_id)
|
|
1026
|
+
p result
|
|
1027
|
+
rescue ScrapeBadger::ApiError => e
|
|
1028
|
+
puts "Error when calling TwitterApi->twitter_get_filter_rule: #{e}"
|
|
1029
|
+
end
|
|
1030
|
+
```
|
|
1031
|
+
|
|
1032
|
+
#### Using the twitter_get_filter_rule_with_http_info variant
|
|
1033
|
+
|
|
1034
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1035
|
+
|
|
1036
|
+
> <Array(<FilterRuleResponse>, Integer, Hash)> twitter_get_filter_rule_with_http_info(rule_id)
|
|
1037
|
+
|
|
1038
|
+
```ruby
|
|
1039
|
+
begin
|
|
1040
|
+
# Get filter rule
|
|
1041
|
+
data, status_code, headers = api_instance.twitter_get_filter_rule_with_http_info(rule_id)
|
|
1042
|
+
p status_code # => 2xx
|
|
1043
|
+
p headers # => { ... }
|
|
1044
|
+
p data # => <FilterRuleResponse>
|
|
1045
|
+
rescue ScrapeBadger::ApiError => e
|
|
1046
|
+
puts "Error when calling TwitterApi->twitter_get_filter_rule_with_http_info: #{e}"
|
|
1047
|
+
end
|
|
1048
|
+
```
|
|
1049
|
+
|
|
1050
|
+
### Parameters
|
|
1051
|
+
|
|
1052
|
+
| Name | Type | Description | Notes |
|
|
1053
|
+
| ---- | ---- | ----------- | ----- |
|
|
1054
|
+
| **rule_id** | **String** | | |
|
|
1055
|
+
|
|
1056
|
+
### Return type
|
|
1057
|
+
|
|
1058
|
+
[**FilterRuleResponse**](FilterRuleResponse.md)
|
|
1059
|
+
|
|
1060
|
+
### Authorization
|
|
1061
|
+
|
|
1062
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1063
|
+
|
|
1064
|
+
### HTTP request headers
|
|
1065
|
+
|
|
1066
|
+
- **Content-Type**: Not defined
|
|
1067
|
+
- **Accept**: application/json
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
## twitter_get_filter_rule_per_poll_rates
|
|
1071
|
+
|
|
1072
|
+
> <PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse> twitter_get_filter_rule_per_poll_rates
|
|
1073
|
+
|
|
1074
|
+
Get filter rule per-poll rates
|
|
1075
|
+
|
|
1076
|
+
Current per-poll rates (auth required — used by SDK + dashboard).
|
|
1077
|
+
|
|
1078
|
+
### Examples
|
|
1079
|
+
|
|
1080
|
+
```ruby
|
|
1081
|
+
require 'time'
|
|
1082
|
+
require 'scrapebadger'
|
|
1083
|
+
# setup authorization
|
|
1084
|
+
ScrapeBadger.configure do |config|
|
|
1085
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1086
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1087
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1088
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1092
|
+
|
|
1093
|
+
begin
|
|
1094
|
+
# Get filter rule per-poll rates
|
|
1095
|
+
result = api_instance.twitter_get_filter_rule_per_poll_rates
|
|
1096
|
+
p result
|
|
1097
|
+
rescue ScrapeBadger::ApiError => e
|
|
1098
|
+
puts "Error when calling TwitterApi->twitter_get_filter_rule_per_poll_rates: #{e}"
|
|
1099
|
+
end
|
|
1100
|
+
```
|
|
1101
|
+
|
|
1102
|
+
#### Using the twitter_get_filter_rule_per_poll_rates_with_http_info variant
|
|
1103
|
+
|
|
1104
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1105
|
+
|
|
1106
|
+
> <Array(<PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse>, Integer, Hash)> twitter_get_filter_rule_per_poll_rates_with_http_info
|
|
1107
|
+
|
|
1108
|
+
```ruby
|
|
1109
|
+
begin
|
|
1110
|
+
# Get filter rule per-poll rates
|
|
1111
|
+
data, status_code, headers = api_instance.twitter_get_filter_rule_per_poll_rates_with_http_info
|
|
1112
|
+
p status_code # => 2xx
|
|
1113
|
+
p headers # => { ... }
|
|
1114
|
+
p data # => <PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse>
|
|
1115
|
+
rescue ScrapeBadger::ApiError => e
|
|
1116
|
+
puts "Error when calling TwitterApi->twitter_get_filter_rule_per_poll_rates_with_http_info: #{e}"
|
|
1117
|
+
end
|
|
1118
|
+
```
|
|
1119
|
+
|
|
1120
|
+
### Parameters
|
|
1121
|
+
|
|
1122
|
+
This endpoint does not need any parameter.
|
|
1123
|
+
|
|
1124
|
+
### Return type
|
|
1125
|
+
|
|
1126
|
+
[**PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse**](PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md)
|
|
1127
|
+
|
|
1128
|
+
### Authorization
|
|
1129
|
+
|
|
1130
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1131
|
+
|
|
1132
|
+
### HTTP request headers
|
|
1133
|
+
|
|
1134
|
+
- **Content-Type**: Not defined
|
|
1135
|
+
- **Accept**: application/json
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
## twitter_get_list_details
|
|
1139
|
+
|
|
1140
|
+
> Object twitter_get_list_details(list_id)
|
|
1141
|
+
|
|
1142
|
+
Get list details
|
|
1143
|
+
|
|
1144
|
+
Get details of a specific list.
|
|
1145
|
+
|
|
1146
|
+
### Examples
|
|
1147
|
+
|
|
1148
|
+
```ruby
|
|
1149
|
+
require 'time'
|
|
1150
|
+
require 'scrapebadger'
|
|
1151
|
+
# setup authorization
|
|
1152
|
+
ScrapeBadger.configure do |config|
|
|
1153
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1154
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1155
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1156
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1157
|
+
end
|
|
1158
|
+
|
|
1159
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1160
|
+
list_id = 'list_id_example' # String |
|
|
1161
|
+
|
|
1162
|
+
begin
|
|
1163
|
+
# Get list details
|
|
1164
|
+
result = api_instance.twitter_get_list_details(list_id)
|
|
1165
|
+
p result
|
|
1166
|
+
rescue ScrapeBadger::ApiError => e
|
|
1167
|
+
puts "Error when calling TwitterApi->twitter_get_list_details: #{e}"
|
|
1168
|
+
end
|
|
1169
|
+
```
|
|
1170
|
+
|
|
1171
|
+
#### Using the twitter_get_list_details_with_http_info variant
|
|
1172
|
+
|
|
1173
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1174
|
+
|
|
1175
|
+
> <Array(Object, Integer, Hash)> twitter_get_list_details_with_http_info(list_id)
|
|
1176
|
+
|
|
1177
|
+
```ruby
|
|
1178
|
+
begin
|
|
1179
|
+
# Get list details
|
|
1180
|
+
data, status_code, headers = api_instance.twitter_get_list_details_with_http_info(list_id)
|
|
1181
|
+
p status_code # => 2xx
|
|
1182
|
+
p headers # => { ... }
|
|
1183
|
+
p data # => Object
|
|
1184
|
+
rescue ScrapeBadger::ApiError => e
|
|
1185
|
+
puts "Error when calling TwitterApi->twitter_get_list_details_with_http_info: #{e}"
|
|
1186
|
+
end
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Parameters
|
|
1190
|
+
|
|
1191
|
+
| Name | Type | Description | Notes |
|
|
1192
|
+
| ---- | ---- | ----------- | ----- |
|
|
1193
|
+
| **list_id** | **String** | | |
|
|
1194
|
+
|
|
1195
|
+
### Return type
|
|
1196
|
+
|
|
1197
|
+
**Object**
|
|
1198
|
+
|
|
1199
|
+
### Authorization
|
|
1200
|
+
|
|
1201
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1202
|
+
|
|
1203
|
+
### HTTP request headers
|
|
1204
|
+
|
|
1205
|
+
- **Content-Type**: Not defined
|
|
1206
|
+
- **Accept**: application/json
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
## twitter_get_list_tweets
|
|
1210
|
+
|
|
1211
|
+
> Object twitter_get_list_tweets(list_id, opts)
|
|
1212
|
+
|
|
1213
|
+
Get list tweets
|
|
1214
|
+
|
|
1215
|
+
Get tweets from a specific list.
|
|
1216
|
+
|
|
1217
|
+
### Examples
|
|
1218
|
+
|
|
1219
|
+
```ruby
|
|
1220
|
+
require 'time'
|
|
1221
|
+
require 'scrapebadger'
|
|
1222
|
+
# setup authorization
|
|
1223
|
+
ScrapeBadger.configure do |config|
|
|
1224
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1225
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1226
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1227
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1228
|
+
end
|
|
1229
|
+
|
|
1230
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1231
|
+
list_id = 'list_id_example' # String |
|
|
1232
|
+
opts = {
|
|
1233
|
+
cursor: 'cursor_example' # String |
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
begin
|
|
1237
|
+
# Get list tweets
|
|
1238
|
+
result = api_instance.twitter_get_list_tweets(list_id, opts)
|
|
1239
|
+
p result
|
|
1240
|
+
rescue ScrapeBadger::ApiError => e
|
|
1241
|
+
puts "Error when calling TwitterApi->twitter_get_list_tweets: #{e}"
|
|
1242
|
+
end
|
|
1243
|
+
```
|
|
1244
|
+
|
|
1245
|
+
#### Using the twitter_get_list_tweets_with_http_info variant
|
|
1246
|
+
|
|
1247
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1248
|
+
|
|
1249
|
+
> <Array(Object, Integer, Hash)> twitter_get_list_tweets_with_http_info(list_id, opts)
|
|
1250
|
+
|
|
1251
|
+
```ruby
|
|
1252
|
+
begin
|
|
1253
|
+
# Get list tweets
|
|
1254
|
+
data, status_code, headers = api_instance.twitter_get_list_tweets_with_http_info(list_id, opts)
|
|
1255
|
+
p status_code # => 2xx
|
|
1256
|
+
p headers # => { ... }
|
|
1257
|
+
p data # => Object
|
|
1258
|
+
rescue ScrapeBadger::ApiError => e
|
|
1259
|
+
puts "Error when calling TwitterApi->twitter_get_list_tweets_with_http_info: #{e}"
|
|
1260
|
+
end
|
|
1261
|
+
```
|
|
1262
|
+
|
|
1263
|
+
### Parameters
|
|
1264
|
+
|
|
1265
|
+
| Name | Type | Description | Notes |
|
|
1266
|
+
| ---- | ---- | ----------- | ----- |
|
|
1267
|
+
| **list_id** | **String** | | |
|
|
1268
|
+
| **cursor** | **String** | | [optional] |
|
|
1269
|
+
|
|
1270
|
+
### Return type
|
|
1271
|
+
|
|
1272
|
+
**Object**
|
|
1273
|
+
|
|
1274
|
+
### Authorization
|
|
1275
|
+
|
|
1276
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1277
|
+
|
|
1278
|
+
### HTTP request headers
|
|
1279
|
+
|
|
1280
|
+
- **Content-Type**: Not defined
|
|
1281
|
+
- **Accept**: application/json
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
## twitter_get_place_details
|
|
1285
|
+
|
|
1286
|
+
> Object twitter_get_place_details(place_id)
|
|
1287
|
+
|
|
1288
|
+
Get place details
|
|
1289
|
+
|
|
1290
|
+
Get details of a specific place.
|
|
1291
|
+
|
|
1292
|
+
### Examples
|
|
1293
|
+
|
|
1294
|
+
```ruby
|
|
1295
|
+
require 'time'
|
|
1296
|
+
require 'scrapebadger'
|
|
1297
|
+
# setup authorization
|
|
1298
|
+
ScrapeBadger.configure do |config|
|
|
1299
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1300
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1301
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1302
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1303
|
+
end
|
|
1304
|
+
|
|
1305
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1306
|
+
place_id = 'place_id_example' # String |
|
|
1307
|
+
|
|
1308
|
+
begin
|
|
1309
|
+
# Get place details
|
|
1310
|
+
result = api_instance.twitter_get_place_details(place_id)
|
|
1311
|
+
p result
|
|
1312
|
+
rescue ScrapeBadger::ApiError => e
|
|
1313
|
+
puts "Error when calling TwitterApi->twitter_get_place_details: #{e}"
|
|
1314
|
+
end
|
|
1315
|
+
```
|
|
1316
|
+
|
|
1317
|
+
#### Using the twitter_get_place_details_with_http_info variant
|
|
1318
|
+
|
|
1319
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1320
|
+
|
|
1321
|
+
> <Array(Object, Integer, Hash)> twitter_get_place_details_with_http_info(place_id)
|
|
1322
|
+
|
|
1323
|
+
```ruby
|
|
1324
|
+
begin
|
|
1325
|
+
# Get place details
|
|
1326
|
+
data, status_code, headers = api_instance.twitter_get_place_details_with_http_info(place_id)
|
|
1327
|
+
p status_code # => 2xx
|
|
1328
|
+
p headers # => { ... }
|
|
1329
|
+
p data # => Object
|
|
1330
|
+
rescue ScrapeBadger::ApiError => e
|
|
1331
|
+
puts "Error when calling TwitterApi->twitter_get_place_details_with_http_info: #{e}"
|
|
1332
|
+
end
|
|
1333
|
+
```
|
|
1334
|
+
|
|
1335
|
+
### Parameters
|
|
1336
|
+
|
|
1337
|
+
| Name | Type | Description | Notes |
|
|
1338
|
+
| ---- | ---- | ----------- | ----- |
|
|
1339
|
+
| **place_id** | **String** | | |
|
|
1340
|
+
|
|
1341
|
+
### Return type
|
|
1342
|
+
|
|
1343
|
+
**Object**
|
|
1344
|
+
|
|
1345
|
+
### Authorization
|
|
1346
|
+
|
|
1347
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1348
|
+
|
|
1349
|
+
### HTTP request headers
|
|
1350
|
+
|
|
1351
|
+
- **Content-Type**: Not defined
|
|
1352
|
+
- **Accept**: application/json
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
## twitter_get_similar_tweets
|
|
1356
|
+
|
|
1357
|
+
> Object twitter_get_similar_tweets(tweet_id)
|
|
1358
|
+
|
|
1359
|
+
Get similar tweets
|
|
1360
|
+
|
|
1361
|
+
Get tweets similar to a specific tweet.
|
|
1362
|
+
|
|
1363
|
+
### Examples
|
|
1364
|
+
|
|
1365
|
+
```ruby
|
|
1366
|
+
require 'time'
|
|
1367
|
+
require 'scrapebadger'
|
|
1368
|
+
# setup authorization
|
|
1369
|
+
ScrapeBadger.configure do |config|
|
|
1370
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1371
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1373
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1376
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1377
|
+
tweet_id = 'tweet_id_example' # String |
|
|
1378
|
+
|
|
1379
|
+
begin
|
|
1380
|
+
# Get similar tweets
|
|
1381
|
+
result = api_instance.twitter_get_similar_tweets(tweet_id)
|
|
1382
|
+
p result
|
|
1383
|
+
rescue ScrapeBadger::ApiError => e
|
|
1384
|
+
puts "Error when calling TwitterApi->twitter_get_similar_tweets: #{e}"
|
|
1385
|
+
end
|
|
1386
|
+
```
|
|
1387
|
+
|
|
1388
|
+
#### Using the twitter_get_similar_tweets_with_http_info variant
|
|
1389
|
+
|
|
1390
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1391
|
+
|
|
1392
|
+
> <Array(Object, Integer, Hash)> twitter_get_similar_tweets_with_http_info(tweet_id)
|
|
1393
|
+
|
|
1394
|
+
```ruby
|
|
1395
|
+
begin
|
|
1396
|
+
# Get similar tweets
|
|
1397
|
+
data, status_code, headers = api_instance.twitter_get_similar_tweets_with_http_info(tweet_id)
|
|
1398
|
+
p status_code # => 2xx
|
|
1399
|
+
p headers # => { ... }
|
|
1400
|
+
p data # => Object
|
|
1401
|
+
rescue ScrapeBadger::ApiError => e
|
|
1402
|
+
puts "Error when calling TwitterApi->twitter_get_similar_tweets_with_http_info: #{e}"
|
|
1403
|
+
end
|
|
1404
|
+
```
|
|
1405
|
+
|
|
1406
|
+
### Parameters
|
|
1407
|
+
|
|
1408
|
+
| Name | Type | Description | Notes |
|
|
1409
|
+
| ---- | ---- | ----------- | ----- |
|
|
1410
|
+
| **tweet_id** | **String** | | |
|
|
1411
|
+
|
|
1412
|
+
### Return type
|
|
1413
|
+
|
|
1414
|
+
**Object**
|
|
1415
|
+
|
|
1416
|
+
### Authorization
|
|
1417
|
+
|
|
1418
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1419
|
+
|
|
1420
|
+
### HTTP request headers
|
|
1421
|
+
|
|
1422
|
+
- **Content-Type**: Not defined
|
|
1423
|
+
- **Accept**: application/json
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
## twitter_get_space_details
|
|
1427
|
+
|
|
1428
|
+
> Object twitter_get_space_details(space_id)
|
|
1429
|
+
|
|
1430
|
+
Get Space details
|
|
1431
|
+
|
|
1432
|
+
Get details of a Twitter Space.
|
|
1433
|
+
|
|
1434
|
+
### Examples
|
|
1435
|
+
|
|
1436
|
+
```ruby
|
|
1437
|
+
require 'time'
|
|
1438
|
+
require 'scrapebadger'
|
|
1439
|
+
# setup authorization
|
|
1440
|
+
ScrapeBadger.configure do |config|
|
|
1441
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1442
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1443
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1444
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1445
|
+
end
|
|
1446
|
+
|
|
1447
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1448
|
+
space_id = 'space_id_example' # String |
|
|
1449
|
+
|
|
1450
|
+
begin
|
|
1451
|
+
# Get Space details
|
|
1452
|
+
result = api_instance.twitter_get_space_details(space_id)
|
|
1453
|
+
p result
|
|
1454
|
+
rescue ScrapeBadger::ApiError => e
|
|
1455
|
+
puts "Error when calling TwitterApi->twitter_get_space_details: #{e}"
|
|
1456
|
+
end
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
#### Using the twitter_get_space_details_with_http_info variant
|
|
1460
|
+
|
|
1461
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1462
|
+
|
|
1463
|
+
> <Array(Object, Integer, Hash)> twitter_get_space_details_with_http_info(space_id)
|
|
1464
|
+
|
|
1465
|
+
```ruby
|
|
1466
|
+
begin
|
|
1467
|
+
# Get Space details
|
|
1468
|
+
data, status_code, headers = api_instance.twitter_get_space_details_with_http_info(space_id)
|
|
1469
|
+
p status_code # => 2xx
|
|
1470
|
+
p headers # => { ... }
|
|
1471
|
+
p data # => Object
|
|
1472
|
+
rescue ScrapeBadger::ApiError => e
|
|
1473
|
+
puts "Error when calling TwitterApi->twitter_get_space_details_with_http_info: #{e}"
|
|
1474
|
+
end
|
|
1475
|
+
```
|
|
1476
|
+
|
|
1477
|
+
### Parameters
|
|
1478
|
+
|
|
1479
|
+
| Name | Type | Description | Notes |
|
|
1480
|
+
| ---- | ---- | ----------- | ----- |
|
|
1481
|
+
| **space_id** | **String** | | |
|
|
1482
|
+
|
|
1483
|
+
### Return type
|
|
1484
|
+
|
|
1485
|
+
**Object**
|
|
1486
|
+
|
|
1487
|
+
### Authorization
|
|
1488
|
+
|
|
1489
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1490
|
+
|
|
1491
|
+
### HTTP request headers
|
|
1492
|
+
|
|
1493
|
+
- **Content-Type**: Not defined
|
|
1494
|
+
- **Accept**: application/json
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
## twitter_get_stream_monitor
|
|
1498
|
+
|
|
1499
|
+
> <StreamMonitorResponse> twitter_get_stream_monitor(monitor_id)
|
|
1500
|
+
|
|
1501
|
+
Get stream monitor
|
|
1502
|
+
|
|
1503
|
+
Get a single stream monitor by ID.
|
|
1504
|
+
|
|
1505
|
+
### Examples
|
|
1506
|
+
|
|
1507
|
+
```ruby
|
|
1508
|
+
require 'time'
|
|
1509
|
+
require 'scrapebadger'
|
|
1510
|
+
# setup authorization
|
|
1511
|
+
ScrapeBadger.configure do |config|
|
|
1512
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1513
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1514
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1515
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1516
|
+
end
|
|
1517
|
+
|
|
1518
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1519
|
+
monitor_id = 'monitor_id_example' # String |
|
|
1520
|
+
|
|
1521
|
+
begin
|
|
1522
|
+
# Get stream monitor
|
|
1523
|
+
result = api_instance.twitter_get_stream_monitor(monitor_id)
|
|
1524
|
+
p result
|
|
1525
|
+
rescue ScrapeBadger::ApiError => e
|
|
1526
|
+
puts "Error when calling TwitterApi->twitter_get_stream_monitor: #{e}"
|
|
1527
|
+
end
|
|
1528
|
+
```
|
|
1529
|
+
|
|
1530
|
+
#### Using the twitter_get_stream_monitor_with_http_info variant
|
|
1531
|
+
|
|
1532
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1533
|
+
|
|
1534
|
+
> <Array(<StreamMonitorResponse>, Integer, Hash)> twitter_get_stream_monitor_with_http_info(monitor_id)
|
|
1535
|
+
|
|
1536
|
+
```ruby
|
|
1537
|
+
begin
|
|
1538
|
+
# Get stream monitor
|
|
1539
|
+
data, status_code, headers = api_instance.twitter_get_stream_monitor_with_http_info(monitor_id)
|
|
1540
|
+
p status_code # => 2xx
|
|
1541
|
+
p headers # => { ... }
|
|
1542
|
+
p data # => <StreamMonitorResponse>
|
|
1543
|
+
rescue ScrapeBadger::ApiError => e
|
|
1544
|
+
puts "Error when calling TwitterApi->twitter_get_stream_monitor_with_http_info: #{e}"
|
|
1545
|
+
end
|
|
1546
|
+
```
|
|
1547
|
+
|
|
1548
|
+
### Parameters
|
|
1549
|
+
|
|
1550
|
+
| Name | Type | Description | Notes |
|
|
1551
|
+
| ---- | ---- | ----------- | ----- |
|
|
1552
|
+
| **monitor_id** | **String** | | |
|
|
1553
|
+
|
|
1554
|
+
### Return type
|
|
1555
|
+
|
|
1556
|
+
[**StreamMonitorResponse**](StreamMonitorResponse.md)
|
|
1557
|
+
|
|
1558
|
+
### Authorization
|
|
1559
|
+
|
|
1560
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1561
|
+
|
|
1562
|
+
### HTTP request headers
|
|
1563
|
+
|
|
1564
|
+
- **Content-Type**: Not defined
|
|
1565
|
+
- **Accept**: application/json
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
## twitter_get_trending_topics
|
|
1569
|
+
|
|
1570
|
+
> Object twitter_get_trending_topics(opts)
|
|
1571
|
+
|
|
1572
|
+
Get trending topics
|
|
1573
|
+
|
|
1574
|
+
Get trending topics.
|
|
1575
|
+
|
|
1576
|
+
### Examples
|
|
1577
|
+
|
|
1578
|
+
```ruby
|
|
1579
|
+
require 'time'
|
|
1580
|
+
require 'scrapebadger'
|
|
1581
|
+
# setup authorization
|
|
1582
|
+
ScrapeBadger.configure do |config|
|
|
1583
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1584
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1585
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1586
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1587
|
+
end
|
|
1588
|
+
|
|
1589
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1590
|
+
opts = {
|
|
1591
|
+
category: 'category_example', # String |
|
|
1592
|
+
count: 56 # Integer |
|
|
1593
|
+
}
|
|
1594
|
+
|
|
1595
|
+
begin
|
|
1596
|
+
# Get trending topics
|
|
1597
|
+
result = api_instance.twitter_get_trending_topics(opts)
|
|
1598
|
+
p result
|
|
1599
|
+
rescue ScrapeBadger::ApiError => e
|
|
1600
|
+
puts "Error when calling TwitterApi->twitter_get_trending_topics: #{e}"
|
|
1601
|
+
end
|
|
1602
|
+
```
|
|
1603
|
+
|
|
1604
|
+
#### Using the twitter_get_trending_topics_with_http_info variant
|
|
1605
|
+
|
|
1606
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1607
|
+
|
|
1608
|
+
> <Array(Object, Integer, Hash)> twitter_get_trending_topics_with_http_info(opts)
|
|
1609
|
+
|
|
1610
|
+
```ruby
|
|
1611
|
+
begin
|
|
1612
|
+
# Get trending topics
|
|
1613
|
+
data, status_code, headers = api_instance.twitter_get_trending_topics_with_http_info(opts)
|
|
1614
|
+
p status_code # => 2xx
|
|
1615
|
+
p headers # => { ... }
|
|
1616
|
+
p data # => Object
|
|
1617
|
+
rescue ScrapeBadger::ApiError => e
|
|
1618
|
+
puts "Error when calling TwitterApi->twitter_get_trending_topics_with_http_info: #{e}"
|
|
1619
|
+
end
|
|
1620
|
+
```
|
|
1621
|
+
|
|
1622
|
+
### Parameters
|
|
1623
|
+
|
|
1624
|
+
| Name | Type | Description | Notes |
|
|
1625
|
+
| ---- | ---- | ----------- | ----- |
|
|
1626
|
+
| **category** | **String** | | [optional] |
|
|
1627
|
+
| **count** | **Integer** | | [optional] |
|
|
1628
|
+
|
|
1629
|
+
### Return type
|
|
1630
|
+
|
|
1631
|
+
**Object**
|
|
1632
|
+
|
|
1633
|
+
### Authorization
|
|
1634
|
+
|
|
1635
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1636
|
+
|
|
1637
|
+
### HTTP request headers
|
|
1638
|
+
|
|
1639
|
+
- **Content-Type**: Not defined
|
|
1640
|
+
- **Accept**: application/json
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
## twitter_get_trends_by_location
|
|
1644
|
+
|
|
1645
|
+
> Object twitter_get_trends_by_location(woeid)
|
|
1646
|
+
|
|
1647
|
+
Get trends by location
|
|
1648
|
+
|
|
1649
|
+
Get trending topics for a specific location (WOEID).
|
|
1650
|
+
|
|
1651
|
+
### Examples
|
|
1652
|
+
|
|
1653
|
+
```ruby
|
|
1654
|
+
require 'time'
|
|
1655
|
+
require 'scrapebadger'
|
|
1656
|
+
# setup authorization
|
|
1657
|
+
ScrapeBadger.configure do |config|
|
|
1658
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1659
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1660
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1661
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1662
|
+
end
|
|
1663
|
+
|
|
1664
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1665
|
+
woeid = 'woeid_example' # String |
|
|
1666
|
+
|
|
1667
|
+
begin
|
|
1668
|
+
# Get trends by location
|
|
1669
|
+
result = api_instance.twitter_get_trends_by_location(woeid)
|
|
1670
|
+
p result
|
|
1671
|
+
rescue ScrapeBadger::ApiError => e
|
|
1672
|
+
puts "Error when calling TwitterApi->twitter_get_trends_by_location: #{e}"
|
|
1673
|
+
end
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
#### Using the twitter_get_trends_by_location_with_http_info variant
|
|
1677
|
+
|
|
1678
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1679
|
+
|
|
1680
|
+
> <Array(Object, Integer, Hash)> twitter_get_trends_by_location_with_http_info(woeid)
|
|
1681
|
+
|
|
1682
|
+
```ruby
|
|
1683
|
+
begin
|
|
1684
|
+
# Get trends by location
|
|
1685
|
+
data, status_code, headers = api_instance.twitter_get_trends_by_location_with_http_info(woeid)
|
|
1686
|
+
p status_code # => 2xx
|
|
1687
|
+
p headers # => { ... }
|
|
1688
|
+
p data # => Object
|
|
1689
|
+
rescue ScrapeBadger::ApiError => e
|
|
1690
|
+
puts "Error when calling TwitterApi->twitter_get_trends_by_location_with_http_info: #{e}"
|
|
1691
|
+
end
|
|
1692
|
+
```
|
|
1693
|
+
|
|
1694
|
+
### Parameters
|
|
1695
|
+
|
|
1696
|
+
| Name | Type | Description | Notes |
|
|
1697
|
+
| ---- | ---- | ----------- | ----- |
|
|
1698
|
+
| **woeid** | **String** | | |
|
|
1699
|
+
|
|
1700
|
+
### Return type
|
|
1701
|
+
|
|
1702
|
+
**Object**
|
|
1703
|
+
|
|
1704
|
+
### Authorization
|
|
1705
|
+
|
|
1706
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1707
|
+
|
|
1708
|
+
### HTTP request headers
|
|
1709
|
+
|
|
1710
|
+
- **Content-Type**: Not defined
|
|
1711
|
+
- **Accept**: application/json
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
## twitter_get_tweet_details
|
|
1715
|
+
|
|
1716
|
+
> Object twitter_get_tweet_details(tweet_id, opts)
|
|
1717
|
+
|
|
1718
|
+
Get tweet details
|
|
1719
|
+
|
|
1720
|
+
Get detailed information about a specific tweet.
|
|
1721
|
+
|
|
1722
|
+
### Examples
|
|
1723
|
+
|
|
1724
|
+
```ruby
|
|
1725
|
+
require 'time'
|
|
1726
|
+
require 'scrapebadger'
|
|
1727
|
+
# setup authorization
|
|
1728
|
+
ScrapeBadger.configure do |config|
|
|
1729
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1730
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1731
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1732
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1733
|
+
end
|
|
1734
|
+
|
|
1735
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1736
|
+
tweet_id = 'tweet_id_example' # String |
|
|
1737
|
+
opts = {
|
|
1738
|
+
cursor: 'cursor_example' # String |
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1741
|
+
begin
|
|
1742
|
+
# Get tweet details
|
|
1743
|
+
result = api_instance.twitter_get_tweet_details(tweet_id, opts)
|
|
1744
|
+
p result
|
|
1745
|
+
rescue ScrapeBadger::ApiError => e
|
|
1746
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_details: #{e}"
|
|
1747
|
+
end
|
|
1748
|
+
```
|
|
1749
|
+
|
|
1750
|
+
#### Using the twitter_get_tweet_details_with_http_info variant
|
|
1751
|
+
|
|
1752
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1753
|
+
|
|
1754
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_details_with_http_info(tweet_id, opts)
|
|
1755
|
+
|
|
1756
|
+
```ruby
|
|
1757
|
+
begin
|
|
1758
|
+
# Get tweet details
|
|
1759
|
+
data, status_code, headers = api_instance.twitter_get_tweet_details_with_http_info(tweet_id, opts)
|
|
1760
|
+
p status_code # => 2xx
|
|
1761
|
+
p headers # => { ... }
|
|
1762
|
+
p data # => Object
|
|
1763
|
+
rescue ScrapeBadger::ApiError => e
|
|
1764
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_details_with_http_info: #{e}"
|
|
1765
|
+
end
|
|
1766
|
+
```
|
|
1767
|
+
|
|
1768
|
+
### Parameters
|
|
1769
|
+
|
|
1770
|
+
| Name | Type | Description | Notes |
|
|
1771
|
+
| ---- | ---- | ----------- | ----- |
|
|
1772
|
+
| **tweet_id** | **String** | | |
|
|
1773
|
+
| **cursor** | **String** | | [optional] |
|
|
1774
|
+
|
|
1775
|
+
### Return type
|
|
1776
|
+
|
|
1777
|
+
**Object**
|
|
1778
|
+
|
|
1779
|
+
### Authorization
|
|
1780
|
+
|
|
1781
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1782
|
+
|
|
1783
|
+
### HTTP request headers
|
|
1784
|
+
|
|
1785
|
+
- **Content-Type**: Not defined
|
|
1786
|
+
- **Accept**: application/json
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
## twitter_get_tweet_edit_history
|
|
1790
|
+
|
|
1791
|
+
> Object twitter_get_tweet_edit_history(tweet_id)
|
|
1792
|
+
|
|
1793
|
+
Get tweet edit history
|
|
1794
|
+
|
|
1795
|
+
Get the edit history of a tweet.
|
|
1796
|
+
|
|
1797
|
+
### Examples
|
|
1798
|
+
|
|
1799
|
+
```ruby
|
|
1800
|
+
require 'time'
|
|
1801
|
+
require 'scrapebadger'
|
|
1802
|
+
# setup authorization
|
|
1803
|
+
ScrapeBadger.configure do |config|
|
|
1804
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1805
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1806
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1807
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1808
|
+
end
|
|
1809
|
+
|
|
1810
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1811
|
+
tweet_id = 'tweet_id_example' # String |
|
|
1812
|
+
|
|
1813
|
+
begin
|
|
1814
|
+
# Get tweet edit history
|
|
1815
|
+
result = api_instance.twitter_get_tweet_edit_history(tweet_id)
|
|
1816
|
+
p result
|
|
1817
|
+
rescue ScrapeBadger::ApiError => e
|
|
1818
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_edit_history: #{e}"
|
|
1819
|
+
end
|
|
1820
|
+
```
|
|
1821
|
+
|
|
1822
|
+
#### Using the twitter_get_tweet_edit_history_with_http_info variant
|
|
1823
|
+
|
|
1824
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1825
|
+
|
|
1826
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_edit_history_with_http_info(tweet_id)
|
|
1827
|
+
|
|
1828
|
+
```ruby
|
|
1829
|
+
begin
|
|
1830
|
+
# Get tweet edit history
|
|
1831
|
+
data, status_code, headers = api_instance.twitter_get_tweet_edit_history_with_http_info(tweet_id)
|
|
1832
|
+
p status_code # => 2xx
|
|
1833
|
+
p headers # => { ... }
|
|
1834
|
+
p data # => Object
|
|
1835
|
+
rescue ScrapeBadger::ApiError => e
|
|
1836
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_edit_history_with_http_info: #{e}"
|
|
1837
|
+
end
|
|
1838
|
+
```
|
|
1839
|
+
|
|
1840
|
+
### Parameters
|
|
1841
|
+
|
|
1842
|
+
| Name | Type | Description | Notes |
|
|
1843
|
+
| ---- | ---- | ----------- | ----- |
|
|
1844
|
+
| **tweet_id** | **String** | | |
|
|
1845
|
+
|
|
1846
|
+
### Return type
|
|
1847
|
+
|
|
1848
|
+
**Object**
|
|
1849
|
+
|
|
1850
|
+
### Authorization
|
|
1851
|
+
|
|
1852
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1853
|
+
|
|
1854
|
+
### HTTP request headers
|
|
1855
|
+
|
|
1856
|
+
- **Content-Type**: Not defined
|
|
1857
|
+
- **Accept**: application/json
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
## twitter_get_tweet_favoriters
|
|
1861
|
+
|
|
1862
|
+
> Object twitter_get_tweet_favoriters(tweet_id, opts)
|
|
1863
|
+
|
|
1864
|
+
Get tweet favoriters
|
|
1865
|
+
|
|
1866
|
+
Get users who favorited a specific tweet.
|
|
1867
|
+
|
|
1868
|
+
### Examples
|
|
1869
|
+
|
|
1870
|
+
```ruby
|
|
1871
|
+
require 'time'
|
|
1872
|
+
require 'scrapebadger'
|
|
1873
|
+
# setup authorization
|
|
1874
|
+
ScrapeBadger.configure do |config|
|
|
1875
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1876
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1877
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1878
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1879
|
+
end
|
|
1880
|
+
|
|
1881
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1882
|
+
tweet_id = 'tweet_id_example' # String |
|
|
1883
|
+
opts = {
|
|
1884
|
+
cursor: 'cursor_example' # String |
|
|
1885
|
+
}
|
|
1886
|
+
|
|
1887
|
+
begin
|
|
1888
|
+
# Get tweet favoriters
|
|
1889
|
+
result = api_instance.twitter_get_tweet_favoriters(tweet_id, opts)
|
|
1890
|
+
p result
|
|
1891
|
+
rescue ScrapeBadger::ApiError => e
|
|
1892
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_favoriters: #{e}"
|
|
1893
|
+
end
|
|
1894
|
+
```
|
|
1895
|
+
|
|
1896
|
+
#### Using the twitter_get_tweet_favoriters_with_http_info variant
|
|
1897
|
+
|
|
1898
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1899
|
+
|
|
1900
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_favoriters_with_http_info(tweet_id, opts)
|
|
1901
|
+
|
|
1902
|
+
```ruby
|
|
1903
|
+
begin
|
|
1904
|
+
# Get tweet favoriters
|
|
1905
|
+
data, status_code, headers = api_instance.twitter_get_tweet_favoriters_with_http_info(tweet_id, opts)
|
|
1906
|
+
p status_code # => 2xx
|
|
1907
|
+
p headers # => { ... }
|
|
1908
|
+
p data # => Object
|
|
1909
|
+
rescue ScrapeBadger::ApiError => e
|
|
1910
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_favoriters_with_http_info: #{e}"
|
|
1911
|
+
end
|
|
1912
|
+
```
|
|
1913
|
+
|
|
1914
|
+
### Parameters
|
|
1915
|
+
|
|
1916
|
+
| Name | Type | Description | Notes |
|
|
1917
|
+
| ---- | ---- | ----------- | ----- |
|
|
1918
|
+
| **tweet_id** | **String** | | |
|
|
1919
|
+
| **cursor** | **String** | | [optional] |
|
|
1920
|
+
|
|
1921
|
+
### Return type
|
|
1922
|
+
|
|
1923
|
+
**Object**
|
|
1924
|
+
|
|
1925
|
+
### Authorization
|
|
1926
|
+
|
|
1927
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
1928
|
+
|
|
1929
|
+
### HTTP request headers
|
|
1930
|
+
|
|
1931
|
+
- **Content-Type**: Not defined
|
|
1932
|
+
- **Accept**: application/json
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
## twitter_get_tweet_quotes
|
|
1936
|
+
|
|
1937
|
+
> Object twitter_get_tweet_quotes(tweet_id, opts)
|
|
1938
|
+
|
|
1939
|
+
Get tweet quotes
|
|
1940
|
+
|
|
1941
|
+
Get tweets that quote a specific tweet.
|
|
1942
|
+
|
|
1943
|
+
### Examples
|
|
1944
|
+
|
|
1945
|
+
```ruby
|
|
1946
|
+
require 'time'
|
|
1947
|
+
require 'scrapebadger'
|
|
1948
|
+
# setup authorization
|
|
1949
|
+
ScrapeBadger.configure do |config|
|
|
1950
|
+
# Configure API key authorization: ApiKeyAuth
|
|
1951
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1952
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1953
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1954
|
+
end
|
|
1955
|
+
|
|
1956
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
1957
|
+
tweet_id = 'tweet_id_example' # String |
|
|
1958
|
+
opts = {
|
|
1959
|
+
cursor: 'cursor_example' # String |
|
|
1960
|
+
}
|
|
1961
|
+
|
|
1962
|
+
begin
|
|
1963
|
+
# Get tweet quotes
|
|
1964
|
+
result = api_instance.twitter_get_tweet_quotes(tweet_id, opts)
|
|
1965
|
+
p result
|
|
1966
|
+
rescue ScrapeBadger::ApiError => e
|
|
1967
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_quotes: #{e}"
|
|
1968
|
+
end
|
|
1969
|
+
```
|
|
1970
|
+
|
|
1971
|
+
#### Using the twitter_get_tweet_quotes_with_http_info variant
|
|
1972
|
+
|
|
1973
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1974
|
+
|
|
1975
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_quotes_with_http_info(tweet_id, opts)
|
|
1976
|
+
|
|
1977
|
+
```ruby
|
|
1978
|
+
begin
|
|
1979
|
+
# Get tweet quotes
|
|
1980
|
+
data, status_code, headers = api_instance.twitter_get_tweet_quotes_with_http_info(tweet_id, opts)
|
|
1981
|
+
p status_code # => 2xx
|
|
1982
|
+
p headers # => { ... }
|
|
1983
|
+
p data # => Object
|
|
1984
|
+
rescue ScrapeBadger::ApiError => e
|
|
1985
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_quotes_with_http_info: #{e}"
|
|
1986
|
+
end
|
|
1987
|
+
```
|
|
1988
|
+
|
|
1989
|
+
### Parameters
|
|
1990
|
+
|
|
1991
|
+
| Name | Type | Description | Notes |
|
|
1992
|
+
| ---- | ---- | ----------- | ----- |
|
|
1993
|
+
| **tweet_id** | **String** | | |
|
|
1994
|
+
| **cursor** | **String** | | [optional] |
|
|
1995
|
+
|
|
1996
|
+
### Return type
|
|
1997
|
+
|
|
1998
|
+
**Object**
|
|
1999
|
+
|
|
2000
|
+
### Authorization
|
|
2001
|
+
|
|
2002
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2003
|
+
|
|
2004
|
+
### HTTP request headers
|
|
2005
|
+
|
|
2006
|
+
- **Content-Type**: Not defined
|
|
2007
|
+
- **Accept**: application/json
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
## twitter_get_tweet_replies
|
|
2011
|
+
|
|
2012
|
+
> Object twitter_get_tweet_replies(tweet_id, opts)
|
|
2013
|
+
|
|
2014
|
+
Get tweet replies
|
|
2015
|
+
|
|
2016
|
+
Get replies to a specific tweet.
|
|
2017
|
+
|
|
2018
|
+
### Examples
|
|
2019
|
+
|
|
2020
|
+
```ruby
|
|
2021
|
+
require 'time'
|
|
2022
|
+
require 'scrapebadger'
|
|
2023
|
+
# setup authorization
|
|
2024
|
+
ScrapeBadger.configure do |config|
|
|
2025
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2026
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2027
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2028
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2029
|
+
end
|
|
2030
|
+
|
|
2031
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2032
|
+
tweet_id = 'tweet_id_example' # String |
|
|
2033
|
+
opts = {
|
|
2034
|
+
cursor: 'cursor_example' # String |
|
|
2035
|
+
}
|
|
2036
|
+
|
|
2037
|
+
begin
|
|
2038
|
+
# Get tweet replies
|
|
2039
|
+
result = api_instance.twitter_get_tweet_replies(tweet_id, opts)
|
|
2040
|
+
p result
|
|
2041
|
+
rescue ScrapeBadger::ApiError => e
|
|
2042
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_replies: #{e}"
|
|
2043
|
+
end
|
|
2044
|
+
```
|
|
2045
|
+
|
|
2046
|
+
#### Using the twitter_get_tweet_replies_with_http_info variant
|
|
2047
|
+
|
|
2048
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2049
|
+
|
|
2050
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_replies_with_http_info(tweet_id, opts)
|
|
2051
|
+
|
|
2052
|
+
```ruby
|
|
2053
|
+
begin
|
|
2054
|
+
# Get tweet replies
|
|
2055
|
+
data, status_code, headers = api_instance.twitter_get_tweet_replies_with_http_info(tweet_id, opts)
|
|
2056
|
+
p status_code # => 2xx
|
|
2057
|
+
p headers # => { ... }
|
|
2058
|
+
p data # => Object
|
|
2059
|
+
rescue ScrapeBadger::ApiError => e
|
|
2060
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_replies_with_http_info: #{e}"
|
|
2061
|
+
end
|
|
2062
|
+
```
|
|
2063
|
+
|
|
2064
|
+
### Parameters
|
|
2065
|
+
|
|
2066
|
+
| Name | Type | Description | Notes |
|
|
2067
|
+
| ---- | ---- | ----------- | ----- |
|
|
2068
|
+
| **tweet_id** | **String** | | |
|
|
2069
|
+
| **cursor** | **String** | | [optional] |
|
|
2070
|
+
|
|
2071
|
+
### Return type
|
|
2072
|
+
|
|
2073
|
+
**Object**
|
|
2074
|
+
|
|
2075
|
+
### Authorization
|
|
2076
|
+
|
|
2077
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2078
|
+
|
|
2079
|
+
### HTTP request headers
|
|
2080
|
+
|
|
2081
|
+
- **Content-Type**: Not defined
|
|
2082
|
+
- **Accept**: application/json
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
## twitter_get_tweet_retweeters
|
|
2086
|
+
|
|
2087
|
+
> Object twitter_get_tweet_retweeters(tweet_id, opts)
|
|
2088
|
+
|
|
2089
|
+
Get tweet retweeters
|
|
2090
|
+
|
|
2091
|
+
Get users who retweeted a specific tweet.
|
|
2092
|
+
|
|
2093
|
+
### Examples
|
|
2094
|
+
|
|
2095
|
+
```ruby
|
|
2096
|
+
require 'time'
|
|
2097
|
+
require 'scrapebadger'
|
|
2098
|
+
# setup authorization
|
|
2099
|
+
ScrapeBadger.configure do |config|
|
|
2100
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2101
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2103
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2104
|
+
end
|
|
2105
|
+
|
|
2106
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2107
|
+
tweet_id = 'tweet_id_example' # String |
|
|
2108
|
+
opts = {
|
|
2109
|
+
cursor: 'cursor_example' # String |
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2112
|
+
begin
|
|
2113
|
+
# Get tweet retweeters
|
|
2114
|
+
result = api_instance.twitter_get_tweet_retweeters(tweet_id, opts)
|
|
2115
|
+
p result
|
|
2116
|
+
rescue ScrapeBadger::ApiError => e
|
|
2117
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_retweeters: #{e}"
|
|
2118
|
+
end
|
|
2119
|
+
```
|
|
2120
|
+
|
|
2121
|
+
#### Using the twitter_get_tweet_retweeters_with_http_info variant
|
|
2122
|
+
|
|
2123
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2124
|
+
|
|
2125
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweet_retweeters_with_http_info(tweet_id, opts)
|
|
2126
|
+
|
|
2127
|
+
```ruby
|
|
2128
|
+
begin
|
|
2129
|
+
# Get tweet retweeters
|
|
2130
|
+
data, status_code, headers = api_instance.twitter_get_tweet_retweeters_with_http_info(tweet_id, opts)
|
|
2131
|
+
p status_code # => 2xx
|
|
2132
|
+
p headers # => { ... }
|
|
2133
|
+
p data # => Object
|
|
2134
|
+
rescue ScrapeBadger::ApiError => e
|
|
2135
|
+
puts "Error when calling TwitterApi->twitter_get_tweet_retweeters_with_http_info: #{e}"
|
|
2136
|
+
end
|
|
2137
|
+
```
|
|
2138
|
+
|
|
2139
|
+
### Parameters
|
|
2140
|
+
|
|
2141
|
+
| Name | Type | Description | Notes |
|
|
2142
|
+
| ---- | ---- | ----------- | ----- |
|
|
2143
|
+
| **tweet_id** | **String** | | |
|
|
2144
|
+
| **cursor** | **String** | | [optional] |
|
|
2145
|
+
|
|
2146
|
+
### Return type
|
|
2147
|
+
|
|
2148
|
+
**Object**
|
|
2149
|
+
|
|
2150
|
+
### Authorization
|
|
2151
|
+
|
|
2152
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2153
|
+
|
|
2154
|
+
### HTTP request headers
|
|
2155
|
+
|
|
2156
|
+
- **Content-Type**: Not defined
|
|
2157
|
+
- **Accept**: application/json
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
## twitter_get_tweets_by_ids
|
|
2161
|
+
|
|
2162
|
+
> Object twitter_get_tweets_by_ids(tweets)
|
|
2163
|
+
|
|
2164
|
+
Get tweets by IDs
|
|
2165
|
+
|
|
2166
|
+
Get multiple tweets by their IDs.
|
|
2167
|
+
|
|
2168
|
+
### Examples
|
|
2169
|
+
|
|
2170
|
+
```ruby
|
|
2171
|
+
require 'time'
|
|
2172
|
+
require 'scrapebadger'
|
|
2173
|
+
# setup authorization
|
|
2174
|
+
ScrapeBadger.configure do |config|
|
|
2175
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2176
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2178
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2179
|
+
end
|
|
2180
|
+
|
|
2181
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2182
|
+
tweets = 'tweets_example' # String |
|
|
2183
|
+
|
|
2184
|
+
begin
|
|
2185
|
+
# Get tweets by IDs
|
|
2186
|
+
result = api_instance.twitter_get_tweets_by_ids(tweets)
|
|
2187
|
+
p result
|
|
2188
|
+
rescue ScrapeBadger::ApiError => e
|
|
2189
|
+
puts "Error when calling TwitterApi->twitter_get_tweets_by_ids: #{e}"
|
|
2190
|
+
end
|
|
2191
|
+
```
|
|
2192
|
+
|
|
2193
|
+
#### Using the twitter_get_tweets_by_ids_with_http_info variant
|
|
2194
|
+
|
|
2195
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2196
|
+
|
|
2197
|
+
> <Array(Object, Integer, Hash)> twitter_get_tweets_by_ids_with_http_info(tweets)
|
|
2198
|
+
|
|
2199
|
+
```ruby
|
|
2200
|
+
begin
|
|
2201
|
+
# Get tweets by IDs
|
|
2202
|
+
data, status_code, headers = api_instance.twitter_get_tweets_by_ids_with_http_info(tweets)
|
|
2203
|
+
p status_code # => 2xx
|
|
2204
|
+
p headers # => { ... }
|
|
2205
|
+
p data # => Object
|
|
2206
|
+
rescue ScrapeBadger::ApiError => e
|
|
2207
|
+
puts "Error when calling TwitterApi->twitter_get_tweets_by_ids_with_http_info: #{e}"
|
|
2208
|
+
end
|
|
2209
|
+
```
|
|
2210
|
+
|
|
2211
|
+
### Parameters
|
|
2212
|
+
|
|
2213
|
+
| Name | Type | Description | Notes |
|
|
2214
|
+
| ---- | ---- | ----------- | ----- |
|
|
2215
|
+
| **tweets** | **String** | | |
|
|
2216
|
+
|
|
2217
|
+
### Return type
|
|
2218
|
+
|
|
2219
|
+
**Object**
|
|
2220
|
+
|
|
2221
|
+
### Authorization
|
|
2222
|
+
|
|
2223
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2224
|
+
|
|
2225
|
+
### HTTP request headers
|
|
2226
|
+
|
|
2227
|
+
- **Content-Type**: Not defined
|
|
2228
|
+
- **Accept**: application/json
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
## twitter_get_user_articles
|
|
2232
|
+
|
|
2233
|
+
> Object twitter_get_user_articles(user_id, opts)
|
|
2234
|
+
|
|
2235
|
+
Get user articles
|
|
2236
|
+
|
|
2237
|
+
Get long-form articles written by a user.
|
|
2238
|
+
|
|
2239
|
+
### Examples
|
|
2240
|
+
|
|
2241
|
+
```ruby
|
|
2242
|
+
require 'time'
|
|
2243
|
+
require 'scrapebadger'
|
|
2244
|
+
# setup authorization
|
|
2245
|
+
ScrapeBadger.configure do |config|
|
|
2246
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2247
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2249
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2250
|
+
end
|
|
2251
|
+
|
|
2252
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2253
|
+
user_id = 'user_id_example' # String |
|
|
2254
|
+
opts = {
|
|
2255
|
+
cursor: 'cursor_example' # String |
|
|
2256
|
+
}
|
|
2257
|
+
|
|
2258
|
+
begin
|
|
2259
|
+
# Get user articles
|
|
2260
|
+
result = api_instance.twitter_get_user_articles(user_id, opts)
|
|
2261
|
+
p result
|
|
2262
|
+
rescue ScrapeBadger::ApiError => e
|
|
2263
|
+
puts "Error when calling TwitterApi->twitter_get_user_articles: #{e}"
|
|
2264
|
+
end
|
|
2265
|
+
```
|
|
2266
|
+
|
|
2267
|
+
#### Using the twitter_get_user_articles_with_http_info variant
|
|
2268
|
+
|
|
2269
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2270
|
+
|
|
2271
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_articles_with_http_info(user_id, opts)
|
|
2272
|
+
|
|
2273
|
+
```ruby
|
|
2274
|
+
begin
|
|
2275
|
+
# Get user articles
|
|
2276
|
+
data, status_code, headers = api_instance.twitter_get_user_articles_with_http_info(user_id, opts)
|
|
2277
|
+
p status_code # => 2xx
|
|
2278
|
+
p headers # => { ... }
|
|
2279
|
+
p data # => Object
|
|
2280
|
+
rescue ScrapeBadger::ApiError => e
|
|
2281
|
+
puts "Error when calling TwitterApi->twitter_get_user_articles_with_http_info: #{e}"
|
|
2282
|
+
end
|
|
2283
|
+
```
|
|
2284
|
+
|
|
2285
|
+
### Parameters
|
|
2286
|
+
|
|
2287
|
+
| Name | Type | Description | Notes |
|
|
2288
|
+
| ---- | ---- | ----------- | ----- |
|
|
2289
|
+
| **user_id** | **String** | | |
|
|
2290
|
+
| **cursor** | **String** | | [optional] |
|
|
2291
|
+
|
|
2292
|
+
### Return type
|
|
2293
|
+
|
|
2294
|
+
**Object**
|
|
2295
|
+
|
|
2296
|
+
### Authorization
|
|
2297
|
+
|
|
2298
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2299
|
+
|
|
2300
|
+
### HTTP request headers
|
|
2301
|
+
|
|
2302
|
+
- **Content-Type**: Not defined
|
|
2303
|
+
- **Accept**: application/json
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
## twitter_get_user_by_id
|
|
2307
|
+
|
|
2308
|
+
> Object twitter_get_user_by_id(user_id)
|
|
2309
|
+
|
|
2310
|
+
Get user by ID
|
|
2311
|
+
|
|
2312
|
+
Get user profile by user ID.
|
|
2313
|
+
|
|
2314
|
+
### Examples
|
|
2315
|
+
|
|
2316
|
+
```ruby
|
|
2317
|
+
require 'time'
|
|
2318
|
+
require 'scrapebadger'
|
|
2319
|
+
# setup authorization
|
|
2320
|
+
ScrapeBadger.configure do |config|
|
|
2321
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2322
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2323
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2324
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2325
|
+
end
|
|
2326
|
+
|
|
2327
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2328
|
+
user_id = 'user_id_example' # String |
|
|
2329
|
+
|
|
2330
|
+
begin
|
|
2331
|
+
# Get user by ID
|
|
2332
|
+
result = api_instance.twitter_get_user_by_id(user_id)
|
|
2333
|
+
p result
|
|
2334
|
+
rescue ScrapeBadger::ApiError => e
|
|
2335
|
+
puts "Error when calling TwitterApi->twitter_get_user_by_id: #{e}"
|
|
2336
|
+
end
|
|
2337
|
+
```
|
|
2338
|
+
|
|
2339
|
+
#### Using the twitter_get_user_by_id_with_http_info variant
|
|
2340
|
+
|
|
2341
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2342
|
+
|
|
2343
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_by_id_with_http_info(user_id)
|
|
2344
|
+
|
|
2345
|
+
```ruby
|
|
2346
|
+
begin
|
|
2347
|
+
# Get user by ID
|
|
2348
|
+
data, status_code, headers = api_instance.twitter_get_user_by_id_with_http_info(user_id)
|
|
2349
|
+
p status_code # => 2xx
|
|
2350
|
+
p headers # => { ... }
|
|
2351
|
+
p data # => Object
|
|
2352
|
+
rescue ScrapeBadger::ApiError => e
|
|
2353
|
+
puts "Error when calling TwitterApi->twitter_get_user_by_id_with_http_info: #{e}"
|
|
2354
|
+
end
|
|
2355
|
+
```
|
|
2356
|
+
|
|
2357
|
+
### Parameters
|
|
2358
|
+
|
|
2359
|
+
| Name | Type | Description | Notes |
|
|
2360
|
+
| ---- | ---- | ----------- | ----- |
|
|
2361
|
+
| **user_id** | **String** | | |
|
|
2362
|
+
|
|
2363
|
+
### Return type
|
|
2364
|
+
|
|
2365
|
+
**Object**
|
|
2366
|
+
|
|
2367
|
+
### Authorization
|
|
2368
|
+
|
|
2369
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2370
|
+
|
|
2371
|
+
### HTTP request headers
|
|
2372
|
+
|
|
2373
|
+
- **Content-Type**: Not defined
|
|
2374
|
+
- **Accept**: application/json
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
## twitter_get_user_by_username
|
|
2378
|
+
|
|
2379
|
+
> Object twitter_get_user_by_username(username)
|
|
2380
|
+
|
|
2381
|
+
Get user by username
|
|
2382
|
+
|
|
2383
|
+
Get user profile by username.
|
|
2384
|
+
|
|
2385
|
+
### Examples
|
|
2386
|
+
|
|
2387
|
+
```ruby
|
|
2388
|
+
require 'time'
|
|
2389
|
+
require 'scrapebadger'
|
|
2390
|
+
# setup authorization
|
|
2391
|
+
ScrapeBadger.configure do |config|
|
|
2392
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2393
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2394
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2395
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2396
|
+
end
|
|
2397
|
+
|
|
2398
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2399
|
+
username = 'username_example' # String |
|
|
2400
|
+
|
|
2401
|
+
begin
|
|
2402
|
+
# Get user by username
|
|
2403
|
+
result = api_instance.twitter_get_user_by_username(username)
|
|
2404
|
+
p result
|
|
2405
|
+
rescue ScrapeBadger::ApiError => e
|
|
2406
|
+
puts "Error when calling TwitterApi->twitter_get_user_by_username: #{e}"
|
|
2407
|
+
end
|
|
2408
|
+
```
|
|
2409
|
+
|
|
2410
|
+
#### Using the twitter_get_user_by_username_with_http_info variant
|
|
2411
|
+
|
|
2412
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2413
|
+
|
|
2414
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_by_username_with_http_info(username)
|
|
2415
|
+
|
|
2416
|
+
```ruby
|
|
2417
|
+
begin
|
|
2418
|
+
# Get user by username
|
|
2419
|
+
data, status_code, headers = api_instance.twitter_get_user_by_username_with_http_info(username)
|
|
2420
|
+
p status_code # => 2xx
|
|
2421
|
+
p headers # => { ... }
|
|
2422
|
+
p data # => Object
|
|
2423
|
+
rescue ScrapeBadger::ApiError => e
|
|
2424
|
+
puts "Error when calling TwitterApi->twitter_get_user_by_username_with_http_info: #{e}"
|
|
2425
|
+
end
|
|
2426
|
+
```
|
|
2427
|
+
|
|
2428
|
+
### Parameters
|
|
2429
|
+
|
|
2430
|
+
| Name | Type | Description | Notes |
|
|
2431
|
+
| ---- | ---- | ----------- | ----- |
|
|
2432
|
+
| **username** | **String** | | |
|
|
2433
|
+
|
|
2434
|
+
### Return type
|
|
2435
|
+
|
|
2436
|
+
**Object**
|
|
2437
|
+
|
|
2438
|
+
### Authorization
|
|
2439
|
+
|
|
2440
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2441
|
+
|
|
2442
|
+
### HTTP request headers
|
|
2443
|
+
|
|
2444
|
+
- **Content-Type**: Not defined
|
|
2445
|
+
- **Accept**: application/json
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
## twitter_get_user_followers
|
|
2449
|
+
|
|
2450
|
+
> Object twitter_get_user_followers(username, opts)
|
|
2451
|
+
|
|
2452
|
+
Get user followers
|
|
2453
|
+
|
|
2454
|
+
Get followers of a specific user.
|
|
2455
|
+
|
|
2456
|
+
### Examples
|
|
2457
|
+
|
|
2458
|
+
```ruby
|
|
2459
|
+
require 'time'
|
|
2460
|
+
require 'scrapebadger'
|
|
2461
|
+
# setup authorization
|
|
2462
|
+
ScrapeBadger.configure do |config|
|
|
2463
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2464
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2465
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2466
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2467
|
+
end
|
|
2468
|
+
|
|
2469
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2470
|
+
username = 'username_example' # String |
|
|
2471
|
+
opts = {
|
|
2472
|
+
cursor: 'cursor_example' # String |
|
|
2473
|
+
}
|
|
2474
|
+
|
|
2475
|
+
begin
|
|
2476
|
+
# Get user followers
|
|
2477
|
+
result = api_instance.twitter_get_user_followers(username, opts)
|
|
2478
|
+
p result
|
|
2479
|
+
rescue ScrapeBadger::ApiError => e
|
|
2480
|
+
puts "Error when calling TwitterApi->twitter_get_user_followers: #{e}"
|
|
2481
|
+
end
|
|
2482
|
+
```
|
|
2483
|
+
|
|
2484
|
+
#### Using the twitter_get_user_followers_with_http_info variant
|
|
2485
|
+
|
|
2486
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2487
|
+
|
|
2488
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_followers_with_http_info(username, opts)
|
|
2489
|
+
|
|
2490
|
+
```ruby
|
|
2491
|
+
begin
|
|
2492
|
+
# Get user followers
|
|
2493
|
+
data, status_code, headers = api_instance.twitter_get_user_followers_with_http_info(username, opts)
|
|
2494
|
+
p status_code # => 2xx
|
|
2495
|
+
p headers # => { ... }
|
|
2496
|
+
p data # => Object
|
|
2497
|
+
rescue ScrapeBadger::ApiError => e
|
|
2498
|
+
puts "Error when calling TwitterApi->twitter_get_user_followers_with_http_info: #{e}"
|
|
2499
|
+
end
|
|
2500
|
+
```
|
|
2501
|
+
|
|
2502
|
+
### Parameters
|
|
2503
|
+
|
|
2504
|
+
| Name | Type | Description | Notes |
|
|
2505
|
+
| ---- | ---- | ----------- | ----- |
|
|
2506
|
+
| **username** | **String** | | |
|
|
2507
|
+
| **cursor** | **String** | | [optional] |
|
|
2508
|
+
|
|
2509
|
+
### Return type
|
|
2510
|
+
|
|
2511
|
+
**Object**
|
|
2512
|
+
|
|
2513
|
+
### Authorization
|
|
2514
|
+
|
|
2515
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2516
|
+
|
|
2517
|
+
### HTTP request headers
|
|
2518
|
+
|
|
2519
|
+
- **Content-Type**: Not defined
|
|
2520
|
+
- **Accept**: application/json
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
## twitter_get_user_following
|
|
2524
|
+
|
|
2525
|
+
> Object twitter_get_user_following(username, opts)
|
|
2526
|
+
|
|
2527
|
+
Get user following
|
|
2528
|
+
|
|
2529
|
+
Get users that a specific user is following.
|
|
2530
|
+
|
|
2531
|
+
### Examples
|
|
2532
|
+
|
|
2533
|
+
```ruby
|
|
2534
|
+
require 'time'
|
|
2535
|
+
require 'scrapebadger'
|
|
2536
|
+
# setup authorization
|
|
2537
|
+
ScrapeBadger.configure do |config|
|
|
2538
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2539
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2541
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2542
|
+
end
|
|
2543
|
+
|
|
2544
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2545
|
+
username = 'username_example' # String |
|
|
2546
|
+
opts = {
|
|
2547
|
+
cursor: 'cursor_example' # String |
|
|
2548
|
+
}
|
|
2549
|
+
|
|
2550
|
+
begin
|
|
2551
|
+
# Get user following
|
|
2552
|
+
result = api_instance.twitter_get_user_following(username, opts)
|
|
2553
|
+
p result
|
|
2554
|
+
rescue ScrapeBadger::ApiError => e
|
|
2555
|
+
puts "Error when calling TwitterApi->twitter_get_user_following: #{e}"
|
|
2556
|
+
end
|
|
2557
|
+
```
|
|
2558
|
+
|
|
2559
|
+
#### Using the twitter_get_user_following_with_http_info variant
|
|
2560
|
+
|
|
2561
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2562
|
+
|
|
2563
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_following_with_http_info(username, opts)
|
|
2564
|
+
|
|
2565
|
+
```ruby
|
|
2566
|
+
begin
|
|
2567
|
+
# Get user following
|
|
2568
|
+
data, status_code, headers = api_instance.twitter_get_user_following_with_http_info(username, opts)
|
|
2569
|
+
p status_code # => 2xx
|
|
2570
|
+
p headers # => { ... }
|
|
2571
|
+
p data # => Object
|
|
2572
|
+
rescue ScrapeBadger::ApiError => e
|
|
2573
|
+
puts "Error when calling TwitterApi->twitter_get_user_following_with_http_info: #{e}"
|
|
2574
|
+
end
|
|
2575
|
+
```
|
|
2576
|
+
|
|
2577
|
+
### Parameters
|
|
2578
|
+
|
|
2579
|
+
| Name | Type | Description | Notes |
|
|
2580
|
+
| ---- | ---- | ----------- | ----- |
|
|
2581
|
+
| **username** | **String** | | |
|
|
2582
|
+
| **cursor** | **String** | | [optional] |
|
|
2583
|
+
|
|
2584
|
+
### Return type
|
|
2585
|
+
|
|
2586
|
+
**Object**
|
|
2587
|
+
|
|
2588
|
+
### Authorization
|
|
2589
|
+
|
|
2590
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2591
|
+
|
|
2592
|
+
### HTTP request headers
|
|
2593
|
+
|
|
2594
|
+
- **Content-Type**: Not defined
|
|
2595
|
+
- **Accept**: application/json
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
## twitter_get_user_mentions
|
|
2599
|
+
|
|
2600
|
+
> Object twitter_get_user_mentions(username, opts)
|
|
2601
|
+
|
|
2602
|
+
Get user mentions
|
|
2603
|
+
|
|
2604
|
+
Get tweets mentioning a specific user.
|
|
2605
|
+
|
|
2606
|
+
### Examples
|
|
2607
|
+
|
|
2608
|
+
```ruby
|
|
2609
|
+
require 'time'
|
|
2610
|
+
require 'scrapebadger'
|
|
2611
|
+
# setup authorization
|
|
2612
|
+
ScrapeBadger.configure do |config|
|
|
2613
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2614
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2615
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2616
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2617
|
+
end
|
|
2618
|
+
|
|
2619
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2620
|
+
username = 'username_example' # String |
|
|
2621
|
+
opts = {
|
|
2622
|
+
count: 56, # Integer |
|
|
2623
|
+
cursor: 'cursor_example' # String |
|
|
2624
|
+
}
|
|
2625
|
+
|
|
2626
|
+
begin
|
|
2627
|
+
# Get user mentions
|
|
2628
|
+
result = api_instance.twitter_get_user_mentions(username, opts)
|
|
2629
|
+
p result
|
|
2630
|
+
rescue ScrapeBadger::ApiError => e
|
|
2631
|
+
puts "Error when calling TwitterApi->twitter_get_user_mentions: #{e}"
|
|
2632
|
+
end
|
|
2633
|
+
```
|
|
2634
|
+
|
|
2635
|
+
#### Using the twitter_get_user_mentions_with_http_info variant
|
|
2636
|
+
|
|
2637
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2638
|
+
|
|
2639
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_mentions_with_http_info(username, opts)
|
|
2640
|
+
|
|
2641
|
+
```ruby
|
|
2642
|
+
begin
|
|
2643
|
+
# Get user mentions
|
|
2644
|
+
data, status_code, headers = api_instance.twitter_get_user_mentions_with_http_info(username, opts)
|
|
2645
|
+
p status_code # => 2xx
|
|
2646
|
+
p headers # => { ... }
|
|
2647
|
+
p data # => Object
|
|
2648
|
+
rescue ScrapeBadger::ApiError => e
|
|
2649
|
+
puts "Error when calling TwitterApi->twitter_get_user_mentions_with_http_info: #{e}"
|
|
2650
|
+
end
|
|
2651
|
+
```
|
|
2652
|
+
|
|
2653
|
+
### Parameters
|
|
2654
|
+
|
|
2655
|
+
| Name | Type | Description | Notes |
|
|
2656
|
+
| ---- | ---- | ----------- | ----- |
|
|
2657
|
+
| **username** | **String** | | |
|
|
2658
|
+
| **count** | **Integer** | | [optional] |
|
|
2659
|
+
| **cursor** | **String** | | [optional] |
|
|
2660
|
+
|
|
2661
|
+
### Return type
|
|
2662
|
+
|
|
2663
|
+
**Object**
|
|
2664
|
+
|
|
2665
|
+
### Authorization
|
|
2666
|
+
|
|
2667
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2668
|
+
|
|
2669
|
+
### HTTP request headers
|
|
2670
|
+
|
|
2671
|
+
- **Content-Type**: Not defined
|
|
2672
|
+
- **Accept**: application/json
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
## twitter_get_user_subscriptions
|
|
2676
|
+
|
|
2677
|
+
> Object twitter_get_user_subscriptions(user_id, opts)
|
|
2678
|
+
|
|
2679
|
+
Get user subscriptions
|
|
2680
|
+
|
|
2681
|
+
Get subscriptions of a specific user.
|
|
2682
|
+
|
|
2683
|
+
### Examples
|
|
2684
|
+
|
|
2685
|
+
```ruby
|
|
2686
|
+
require 'time'
|
|
2687
|
+
require 'scrapebadger'
|
|
2688
|
+
# setup authorization
|
|
2689
|
+
ScrapeBadger.configure do |config|
|
|
2690
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2691
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2692
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2693
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2694
|
+
end
|
|
2695
|
+
|
|
2696
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2697
|
+
user_id = 'user_id_example' # String |
|
|
2698
|
+
opts = {
|
|
2699
|
+
cursor: 'cursor_example' # String |
|
|
2700
|
+
}
|
|
2701
|
+
|
|
2702
|
+
begin
|
|
2703
|
+
# Get user subscriptions
|
|
2704
|
+
result = api_instance.twitter_get_user_subscriptions(user_id, opts)
|
|
2705
|
+
p result
|
|
2706
|
+
rescue ScrapeBadger::ApiError => e
|
|
2707
|
+
puts "Error when calling TwitterApi->twitter_get_user_subscriptions: #{e}"
|
|
2708
|
+
end
|
|
2709
|
+
```
|
|
2710
|
+
|
|
2711
|
+
#### Using the twitter_get_user_subscriptions_with_http_info variant
|
|
2712
|
+
|
|
2713
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2714
|
+
|
|
2715
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_subscriptions_with_http_info(user_id, opts)
|
|
2716
|
+
|
|
2717
|
+
```ruby
|
|
2718
|
+
begin
|
|
2719
|
+
# Get user subscriptions
|
|
2720
|
+
data, status_code, headers = api_instance.twitter_get_user_subscriptions_with_http_info(user_id, opts)
|
|
2721
|
+
p status_code # => 2xx
|
|
2722
|
+
p headers # => { ... }
|
|
2723
|
+
p data # => Object
|
|
2724
|
+
rescue ScrapeBadger::ApiError => e
|
|
2725
|
+
puts "Error when calling TwitterApi->twitter_get_user_subscriptions_with_http_info: #{e}"
|
|
2726
|
+
end
|
|
2727
|
+
```
|
|
2728
|
+
|
|
2729
|
+
### Parameters
|
|
2730
|
+
|
|
2731
|
+
| Name | Type | Description | Notes |
|
|
2732
|
+
| ---- | ---- | ----------- | ----- |
|
|
2733
|
+
| **user_id** | **String** | | |
|
|
2734
|
+
| **cursor** | **String** | | [optional] |
|
|
2735
|
+
|
|
2736
|
+
### Return type
|
|
2737
|
+
|
|
2738
|
+
**Object**
|
|
2739
|
+
|
|
2740
|
+
### Authorization
|
|
2741
|
+
|
|
2742
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2743
|
+
|
|
2744
|
+
### HTTP request headers
|
|
2745
|
+
|
|
2746
|
+
- **Content-Type**: Not defined
|
|
2747
|
+
- **Accept**: application/json
|
|
2748
|
+
|
|
2749
|
+
|
|
2750
|
+
## twitter_get_user_tweets
|
|
2751
|
+
|
|
2752
|
+
> Object twitter_get_user_tweets(username, opts)
|
|
2753
|
+
|
|
2754
|
+
Get user tweets
|
|
2755
|
+
|
|
2756
|
+
Get latest tweets from a specific user.
|
|
2757
|
+
|
|
2758
|
+
### Examples
|
|
2759
|
+
|
|
2760
|
+
```ruby
|
|
2761
|
+
require 'time'
|
|
2762
|
+
require 'scrapebadger'
|
|
2763
|
+
# setup authorization
|
|
2764
|
+
ScrapeBadger.configure do |config|
|
|
2765
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2766
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2767
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2768
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2769
|
+
end
|
|
2770
|
+
|
|
2771
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2772
|
+
username = 'username_example' # String |
|
|
2773
|
+
opts = {
|
|
2774
|
+
cursor: 'cursor_example' # String |
|
|
2775
|
+
}
|
|
2776
|
+
|
|
2777
|
+
begin
|
|
2778
|
+
# Get user tweets
|
|
2779
|
+
result = api_instance.twitter_get_user_tweets(username, opts)
|
|
2780
|
+
p result
|
|
2781
|
+
rescue ScrapeBadger::ApiError => e
|
|
2782
|
+
puts "Error when calling TwitterApi->twitter_get_user_tweets: #{e}"
|
|
2783
|
+
end
|
|
2784
|
+
```
|
|
2785
|
+
|
|
2786
|
+
#### Using the twitter_get_user_tweets_with_http_info variant
|
|
2787
|
+
|
|
2788
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2789
|
+
|
|
2790
|
+
> <Array(Object, Integer, Hash)> twitter_get_user_tweets_with_http_info(username, opts)
|
|
2791
|
+
|
|
2792
|
+
```ruby
|
|
2793
|
+
begin
|
|
2794
|
+
# Get user tweets
|
|
2795
|
+
data, status_code, headers = api_instance.twitter_get_user_tweets_with_http_info(username, opts)
|
|
2796
|
+
p status_code # => 2xx
|
|
2797
|
+
p headers # => { ... }
|
|
2798
|
+
p data # => Object
|
|
2799
|
+
rescue ScrapeBadger::ApiError => e
|
|
2800
|
+
puts "Error when calling TwitterApi->twitter_get_user_tweets_with_http_info: #{e}"
|
|
2801
|
+
end
|
|
2802
|
+
```
|
|
2803
|
+
|
|
2804
|
+
### Parameters
|
|
2805
|
+
|
|
2806
|
+
| Name | Type | Description | Notes |
|
|
2807
|
+
| ---- | ---- | ----------- | ----- |
|
|
2808
|
+
| **username** | **String** | | |
|
|
2809
|
+
| **cursor** | **String** | | [optional] |
|
|
2810
|
+
|
|
2811
|
+
### Return type
|
|
2812
|
+
|
|
2813
|
+
**Object**
|
|
2814
|
+
|
|
2815
|
+
### Authorization
|
|
2816
|
+
|
|
2817
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2818
|
+
|
|
2819
|
+
### HTTP request headers
|
|
2820
|
+
|
|
2821
|
+
- **Content-Type**: Not defined
|
|
2822
|
+
- **Accept**: application/json
|
|
2823
|
+
|
|
2824
|
+
|
|
2825
|
+
## twitter_list_billing_logs
|
|
2826
|
+
|
|
2827
|
+
> <BillingLogListResponse> twitter_list_billing_logs(opts)
|
|
2828
|
+
|
|
2829
|
+
List billing logs
|
|
2830
|
+
|
|
2831
|
+
List billing activity logs for the authenticated API key's monitors.
|
|
2832
|
+
|
|
2833
|
+
### Examples
|
|
2834
|
+
|
|
2835
|
+
```ruby
|
|
2836
|
+
require 'time'
|
|
2837
|
+
require 'scrapebadger'
|
|
2838
|
+
# setup authorization
|
|
2839
|
+
ScrapeBadger.configure do |config|
|
|
2840
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2841
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2842
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2843
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2844
|
+
end
|
|
2845
|
+
|
|
2846
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2847
|
+
opts = {
|
|
2848
|
+
monitor_id: 'monitor_id_example', # String |
|
|
2849
|
+
page: 56, # Integer |
|
|
2850
|
+
page_size: 56 # Integer |
|
|
2851
|
+
}
|
|
2852
|
+
|
|
2853
|
+
begin
|
|
2854
|
+
# List billing logs
|
|
2855
|
+
result = api_instance.twitter_list_billing_logs(opts)
|
|
2856
|
+
p result
|
|
2857
|
+
rescue ScrapeBadger::ApiError => e
|
|
2858
|
+
puts "Error when calling TwitterApi->twitter_list_billing_logs: #{e}"
|
|
2859
|
+
end
|
|
2860
|
+
```
|
|
2861
|
+
|
|
2862
|
+
#### Using the twitter_list_billing_logs_with_http_info variant
|
|
2863
|
+
|
|
2864
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2865
|
+
|
|
2866
|
+
> <Array(<BillingLogListResponse>, Integer, Hash)> twitter_list_billing_logs_with_http_info(opts)
|
|
2867
|
+
|
|
2868
|
+
```ruby
|
|
2869
|
+
begin
|
|
2870
|
+
# List billing logs
|
|
2871
|
+
data, status_code, headers = api_instance.twitter_list_billing_logs_with_http_info(opts)
|
|
2872
|
+
p status_code # => 2xx
|
|
2873
|
+
p headers # => { ... }
|
|
2874
|
+
p data # => <BillingLogListResponse>
|
|
2875
|
+
rescue ScrapeBadger::ApiError => e
|
|
2876
|
+
puts "Error when calling TwitterApi->twitter_list_billing_logs_with_http_info: #{e}"
|
|
2877
|
+
end
|
|
2878
|
+
```
|
|
2879
|
+
|
|
2880
|
+
### Parameters
|
|
2881
|
+
|
|
2882
|
+
| Name | Type | Description | Notes |
|
|
2883
|
+
| ---- | ---- | ----------- | ----- |
|
|
2884
|
+
| **monitor_id** | **String** | | [optional] |
|
|
2885
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
2886
|
+
| **page_size** | **Integer** | | [optional][default to 20] |
|
|
2887
|
+
|
|
2888
|
+
### Return type
|
|
2889
|
+
|
|
2890
|
+
[**BillingLogListResponse**](BillingLogListResponse.md)
|
|
2891
|
+
|
|
2892
|
+
### Authorization
|
|
2893
|
+
|
|
2894
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2895
|
+
|
|
2896
|
+
### HTTP request headers
|
|
2897
|
+
|
|
2898
|
+
- **Content-Type**: Not defined
|
|
2899
|
+
- **Accept**: application/json
|
|
2900
|
+
|
|
2901
|
+
|
|
2902
|
+
## twitter_list_delivery_logs_for_a_filter_rule
|
|
2903
|
+
|
|
2904
|
+
> <FilterRuleDeliveryLogListResponse> twitter_list_delivery_logs_for_a_filter_rule(rule_id, opts)
|
|
2905
|
+
|
|
2906
|
+
List delivery logs for a filter rule
|
|
2907
|
+
|
|
2908
|
+
List tweet delivery logs for a specific filter rule.
|
|
2909
|
+
|
|
2910
|
+
### Examples
|
|
2911
|
+
|
|
2912
|
+
```ruby
|
|
2913
|
+
require 'time'
|
|
2914
|
+
require 'scrapebadger'
|
|
2915
|
+
# setup authorization
|
|
2916
|
+
ScrapeBadger.configure do |config|
|
|
2917
|
+
# Configure API key authorization: ApiKeyAuth
|
|
2918
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
2919
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2920
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
2921
|
+
end
|
|
2922
|
+
|
|
2923
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
2924
|
+
rule_id = 'rule_id_example' # String |
|
|
2925
|
+
opts = {
|
|
2926
|
+
delivery_status: 'delivery_status_example', # String |
|
|
2927
|
+
author_username: 'author_username_example', # String |
|
|
2928
|
+
page: 56, # Integer |
|
|
2929
|
+
page_size: 56, # Integer |
|
|
2930
|
+
sort: 'asc' # String |
|
|
2931
|
+
}
|
|
2932
|
+
|
|
2933
|
+
begin
|
|
2934
|
+
# List delivery logs for a filter rule
|
|
2935
|
+
result = api_instance.twitter_list_delivery_logs_for_a_filter_rule(rule_id, opts)
|
|
2936
|
+
p result
|
|
2937
|
+
rescue ScrapeBadger::ApiError => e
|
|
2938
|
+
puts "Error when calling TwitterApi->twitter_list_delivery_logs_for_a_filter_rule: #{e}"
|
|
2939
|
+
end
|
|
2940
|
+
```
|
|
2941
|
+
|
|
2942
|
+
#### Using the twitter_list_delivery_logs_for_a_filter_rule_with_http_info variant
|
|
2943
|
+
|
|
2944
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2945
|
+
|
|
2946
|
+
> <Array(<FilterRuleDeliveryLogListResponse>, Integer, Hash)> twitter_list_delivery_logs_for_a_filter_rule_with_http_info(rule_id, opts)
|
|
2947
|
+
|
|
2948
|
+
```ruby
|
|
2949
|
+
begin
|
|
2950
|
+
# List delivery logs for a filter rule
|
|
2951
|
+
data, status_code, headers = api_instance.twitter_list_delivery_logs_for_a_filter_rule_with_http_info(rule_id, opts)
|
|
2952
|
+
p status_code # => 2xx
|
|
2953
|
+
p headers # => { ... }
|
|
2954
|
+
p data # => <FilterRuleDeliveryLogListResponse>
|
|
2955
|
+
rescue ScrapeBadger::ApiError => e
|
|
2956
|
+
puts "Error when calling TwitterApi->twitter_list_delivery_logs_for_a_filter_rule_with_http_info: #{e}"
|
|
2957
|
+
end
|
|
2958
|
+
```
|
|
2959
|
+
|
|
2960
|
+
### Parameters
|
|
2961
|
+
|
|
2962
|
+
| Name | Type | Description | Notes |
|
|
2963
|
+
| ---- | ---- | ----------- | ----- |
|
|
2964
|
+
| **rule_id** | **String** | | |
|
|
2965
|
+
| **delivery_status** | **String** | | [optional] |
|
|
2966
|
+
| **author_username** | **String** | | [optional] |
|
|
2967
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
2968
|
+
| **page_size** | **Integer** | | [optional][default to 20] |
|
|
2969
|
+
| **sort** | **String** | | [optional][default to 'desc'] |
|
|
2970
|
+
|
|
2971
|
+
### Return type
|
|
2972
|
+
|
|
2973
|
+
[**FilterRuleDeliveryLogListResponse**](FilterRuleDeliveryLogListResponse.md)
|
|
2974
|
+
|
|
2975
|
+
### Authorization
|
|
2976
|
+
|
|
2977
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
2978
|
+
|
|
2979
|
+
### HTTP request headers
|
|
2980
|
+
|
|
2981
|
+
- **Content-Type**: Not defined
|
|
2982
|
+
- **Accept**: application/json
|
|
2983
|
+
|
|
2984
|
+
|
|
2985
|
+
## twitter_list_filter_rules
|
|
2986
|
+
|
|
2987
|
+
> <FilterRuleListResponse> twitter_list_filter_rules(opts)
|
|
2988
|
+
|
|
2989
|
+
List filter rules
|
|
2990
|
+
|
|
2991
|
+
List all filter rules for the authenticated API key.
|
|
2992
|
+
|
|
2993
|
+
### Examples
|
|
2994
|
+
|
|
2995
|
+
```ruby
|
|
2996
|
+
require 'time'
|
|
2997
|
+
require 'scrapebadger'
|
|
2998
|
+
# setup authorization
|
|
2999
|
+
ScrapeBadger.configure do |config|
|
|
3000
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3001
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3002
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3003
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3004
|
+
end
|
|
3005
|
+
|
|
3006
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3007
|
+
opts = {
|
|
3008
|
+
status: 'status_example', # String |
|
|
3009
|
+
page: 56, # Integer |
|
|
3010
|
+
page_size: 56 # Integer |
|
|
3011
|
+
}
|
|
3012
|
+
|
|
3013
|
+
begin
|
|
3014
|
+
# List filter rules
|
|
3015
|
+
result = api_instance.twitter_list_filter_rules(opts)
|
|
3016
|
+
p result
|
|
3017
|
+
rescue ScrapeBadger::ApiError => e
|
|
3018
|
+
puts "Error when calling TwitterApi->twitter_list_filter_rules: #{e}"
|
|
3019
|
+
end
|
|
3020
|
+
```
|
|
3021
|
+
|
|
3022
|
+
#### Using the twitter_list_filter_rules_with_http_info variant
|
|
3023
|
+
|
|
3024
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3025
|
+
|
|
3026
|
+
> <Array(<FilterRuleListResponse>, Integer, Hash)> twitter_list_filter_rules_with_http_info(opts)
|
|
3027
|
+
|
|
3028
|
+
```ruby
|
|
3029
|
+
begin
|
|
3030
|
+
# List filter rules
|
|
3031
|
+
data, status_code, headers = api_instance.twitter_list_filter_rules_with_http_info(opts)
|
|
3032
|
+
p status_code # => 2xx
|
|
3033
|
+
p headers # => { ... }
|
|
3034
|
+
p data # => <FilterRuleListResponse>
|
|
3035
|
+
rescue ScrapeBadger::ApiError => e
|
|
3036
|
+
puts "Error when calling TwitterApi->twitter_list_filter_rules_with_http_info: #{e}"
|
|
3037
|
+
end
|
|
3038
|
+
```
|
|
3039
|
+
|
|
3040
|
+
### Parameters
|
|
3041
|
+
|
|
3042
|
+
| Name | Type | Description | Notes |
|
|
3043
|
+
| ---- | ---- | ----------- | ----- |
|
|
3044
|
+
| **status** | **String** | | [optional] |
|
|
3045
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
3046
|
+
| **page_size** | **Integer** | | [optional][default to 20] |
|
|
3047
|
+
|
|
3048
|
+
### Return type
|
|
3049
|
+
|
|
3050
|
+
[**FilterRuleListResponse**](FilterRuleListResponse.md)
|
|
3051
|
+
|
|
3052
|
+
### Authorization
|
|
3053
|
+
|
|
3054
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3055
|
+
|
|
3056
|
+
### HTTP request headers
|
|
3057
|
+
|
|
3058
|
+
- **Content-Type**: Not defined
|
|
3059
|
+
- **Accept**: application/json
|
|
3060
|
+
|
|
3061
|
+
|
|
3062
|
+
## twitter_list_stream_monitors
|
|
3063
|
+
|
|
3064
|
+
> <StreamMonitorListResponse> twitter_list_stream_monitors(opts)
|
|
3065
|
+
|
|
3066
|
+
List stream monitors
|
|
3067
|
+
|
|
3068
|
+
List all stream monitors for the authenticated API key.
|
|
3069
|
+
|
|
3070
|
+
### Examples
|
|
3071
|
+
|
|
3072
|
+
```ruby
|
|
3073
|
+
require 'time'
|
|
3074
|
+
require 'scrapebadger'
|
|
3075
|
+
# setup authorization
|
|
3076
|
+
ScrapeBadger.configure do |config|
|
|
3077
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3078
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3079
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3080
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3081
|
+
end
|
|
3082
|
+
|
|
3083
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3084
|
+
opts = {
|
|
3085
|
+
status: 'status_example', # String |
|
|
3086
|
+
page: 56, # Integer |
|
|
3087
|
+
page_size: 56 # Integer |
|
|
3088
|
+
}
|
|
3089
|
+
|
|
3090
|
+
begin
|
|
3091
|
+
# List stream monitors
|
|
3092
|
+
result = api_instance.twitter_list_stream_monitors(opts)
|
|
3093
|
+
p result
|
|
3094
|
+
rescue ScrapeBadger::ApiError => e
|
|
3095
|
+
puts "Error when calling TwitterApi->twitter_list_stream_monitors: #{e}"
|
|
3096
|
+
end
|
|
3097
|
+
```
|
|
3098
|
+
|
|
3099
|
+
#### Using the twitter_list_stream_monitors_with_http_info variant
|
|
3100
|
+
|
|
3101
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3102
|
+
|
|
3103
|
+
> <Array(<StreamMonitorListResponse>, Integer, Hash)> twitter_list_stream_monitors_with_http_info(opts)
|
|
3104
|
+
|
|
3105
|
+
```ruby
|
|
3106
|
+
begin
|
|
3107
|
+
# List stream monitors
|
|
3108
|
+
data, status_code, headers = api_instance.twitter_list_stream_monitors_with_http_info(opts)
|
|
3109
|
+
p status_code # => 2xx
|
|
3110
|
+
p headers # => { ... }
|
|
3111
|
+
p data # => <StreamMonitorListResponse>
|
|
3112
|
+
rescue ScrapeBadger::ApiError => e
|
|
3113
|
+
puts "Error when calling TwitterApi->twitter_list_stream_monitors_with_http_info: #{e}"
|
|
3114
|
+
end
|
|
3115
|
+
```
|
|
3116
|
+
|
|
3117
|
+
### Parameters
|
|
3118
|
+
|
|
3119
|
+
| Name | Type | Description | Notes |
|
|
3120
|
+
| ---- | ---- | ----------- | ----- |
|
|
3121
|
+
| **status** | **String** | | [optional] |
|
|
3122
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
3123
|
+
| **page_size** | **Integer** | | [optional][default to 20] |
|
|
3124
|
+
|
|
3125
|
+
### Return type
|
|
3126
|
+
|
|
3127
|
+
[**StreamMonitorListResponse**](StreamMonitorListResponse.md)
|
|
3128
|
+
|
|
3129
|
+
### Authorization
|
|
3130
|
+
|
|
3131
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3132
|
+
|
|
3133
|
+
### HTTP request headers
|
|
3134
|
+
|
|
3135
|
+
- **Content-Type**: Not defined
|
|
3136
|
+
- **Accept**: application/json
|
|
3137
|
+
|
|
3138
|
+
|
|
3139
|
+
## twitter_list_tweet_delivery_logs
|
|
3140
|
+
|
|
3141
|
+
> <TweetDeliveryLogListResponse> twitter_list_tweet_delivery_logs(opts)
|
|
3142
|
+
|
|
3143
|
+
List tweet delivery logs
|
|
3144
|
+
|
|
3145
|
+
List tweet delivery logs for the authenticated API key's monitors.
|
|
3146
|
+
|
|
3147
|
+
### Examples
|
|
3148
|
+
|
|
3149
|
+
```ruby
|
|
3150
|
+
require 'time'
|
|
3151
|
+
require 'scrapebadger'
|
|
3152
|
+
# setup authorization
|
|
3153
|
+
ScrapeBadger.configure do |config|
|
|
3154
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3155
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3156
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3157
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3158
|
+
end
|
|
3159
|
+
|
|
3160
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3161
|
+
opts = {
|
|
3162
|
+
monitor_id: 'monitor_id_example', # String |
|
|
3163
|
+
author_username: 'author_username_example', # String |
|
|
3164
|
+
delivery_status: 'delivery_status_example', # String |
|
|
3165
|
+
page: 56, # Integer |
|
|
3166
|
+
page_size: 56, # Integer |
|
|
3167
|
+
sort: 'asc' # String |
|
|
3168
|
+
}
|
|
3169
|
+
|
|
3170
|
+
begin
|
|
3171
|
+
# List tweet delivery logs
|
|
3172
|
+
result = api_instance.twitter_list_tweet_delivery_logs(opts)
|
|
3173
|
+
p result
|
|
3174
|
+
rescue ScrapeBadger::ApiError => e
|
|
3175
|
+
puts "Error when calling TwitterApi->twitter_list_tweet_delivery_logs: #{e}"
|
|
3176
|
+
end
|
|
3177
|
+
```
|
|
3178
|
+
|
|
3179
|
+
#### Using the twitter_list_tweet_delivery_logs_with_http_info variant
|
|
3180
|
+
|
|
3181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3182
|
+
|
|
3183
|
+
> <Array(<TweetDeliveryLogListResponse>, Integer, Hash)> twitter_list_tweet_delivery_logs_with_http_info(opts)
|
|
3184
|
+
|
|
3185
|
+
```ruby
|
|
3186
|
+
begin
|
|
3187
|
+
# List tweet delivery logs
|
|
3188
|
+
data, status_code, headers = api_instance.twitter_list_tweet_delivery_logs_with_http_info(opts)
|
|
3189
|
+
p status_code # => 2xx
|
|
3190
|
+
p headers # => { ... }
|
|
3191
|
+
p data # => <TweetDeliveryLogListResponse>
|
|
3192
|
+
rescue ScrapeBadger::ApiError => e
|
|
3193
|
+
puts "Error when calling TwitterApi->twitter_list_tweet_delivery_logs_with_http_info: #{e}"
|
|
3194
|
+
end
|
|
3195
|
+
```
|
|
3196
|
+
|
|
3197
|
+
### Parameters
|
|
3198
|
+
|
|
3199
|
+
| Name | Type | Description | Notes |
|
|
3200
|
+
| ---- | ---- | ----------- | ----- |
|
|
3201
|
+
| **monitor_id** | **String** | | [optional] |
|
|
3202
|
+
| **author_username** | **String** | | [optional] |
|
|
3203
|
+
| **delivery_status** | **String** | | [optional] |
|
|
3204
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
3205
|
+
| **page_size** | **Integer** | | [optional][default to 20] |
|
|
3206
|
+
| **sort** | **String** | | [optional][default to 'desc'] |
|
|
3207
|
+
|
|
3208
|
+
### Return type
|
|
3209
|
+
|
|
3210
|
+
[**TweetDeliveryLogListResponse**](TweetDeliveryLogListResponse.md)
|
|
3211
|
+
|
|
3212
|
+
### Authorization
|
|
3213
|
+
|
|
3214
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3215
|
+
|
|
3216
|
+
### HTTP request headers
|
|
3217
|
+
|
|
3218
|
+
- **Content-Type**: Not defined
|
|
3219
|
+
- **Accept**: application/json
|
|
3220
|
+
|
|
3221
|
+
|
|
3222
|
+
## twitter_list_webhooks
|
|
3223
|
+
|
|
3224
|
+
> <WebhookListResponse> twitter_list_webhooks(opts)
|
|
3225
|
+
|
|
3226
|
+
List webhooks
|
|
3227
|
+
|
|
3228
|
+
List all webhook-configured monitors for the authenticated API key.
|
|
3229
|
+
|
|
3230
|
+
### Examples
|
|
3231
|
+
|
|
3232
|
+
```ruby
|
|
3233
|
+
require 'time'
|
|
3234
|
+
require 'scrapebadger'
|
|
3235
|
+
# setup authorization
|
|
3236
|
+
ScrapeBadger.configure do |config|
|
|
3237
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3238
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3239
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3240
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3241
|
+
end
|
|
3242
|
+
|
|
3243
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3244
|
+
opts = {
|
|
3245
|
+
monitor_id: 'monitor_id_example' # String |
|
|
3246
|
+
}
|
|
3247
|
+
|
|
3248
|
+
begin
|
|
3249
|
+
# List webhooks
|
|
3250
|
+
result = api_instance.twitter_list_webhooks(opts)
|
|
3251
|
+
p result
|
|
3252
|
+
rescue ScrapeBadger::ApiError => e
|
|
3253
|
+
puts "Error when calling TwitterApi->twitter_list_webhooks: #{e}"
|
|
3254
|
+
end
|
|
3255
|
+
```
|
|
3256
|
+
|
|
3257
|
+
#### Using the twitter_list_webhooks_with_http_info variant
|
|
3258
|
+
|
|
3259
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3260
|
+
|
|
3261
|
+
> <Array(<WebhookListResponse>, Integer, Hash)> twitter_list_webhooks_with_http_info(opts)
|
|
3262
|
+
|
|
3263
|
+
```ruby
|
|
3264
|
+
begin
|
|
3265
|
+
# List webhooks
|
|
3266
|
+
data, status_code, headers = api_instance.twitter_list_webhooks_with_http_info(opts)
|
|
3267
|
+
p status_code # => 2xx
|
|
3268
|
+
p headers # => { ... }
|
|
3269
|
+
p data # => <WebhookListResponse>
|
|
3270
|
+
rescue ScrapeBadger::ApiError => e
|
|
3271
|
+
puts "Error when calling TwitterApi->twitter_list_webhooks_with_http_info: #{e}"
|
|
3272
|
+
end
|
|
3273
|
+
```
|
|
3274
|
+
|
|
3275
|
+
### Parameters
|
|
3276
|
+
|
|
3277
|
+
| Name | Type | Description | Notes |
|
|
3278
|
+
| ---- | ---- | ----------- | ----- |
|
|
3279
|
+
| **monitor_id** | **String** | | [optional] |
|
|
3280
|
+
|
|
3281
|
+
### Return type
|
|
3282
|
+
|
|
3283
|
+
[**WebhookListResponse**](WebhookListResponse.md)
|
|
3284
|
+
|
|
3285
|
+
### Authorization
|
|
3286
|
+
|
|
3287
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3288
|
+
|
|
3289
|
+
### HTTP request headers
|
|
3290
|
+
|
|
3291
|
+
- **Content-Type**: Not defined
|
|
3292
|
+
- **Accept**: application/json
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
## twitter_remove_webhook_from_monitor
|
|
3296
|
+
|
|
3297
|
+
> twitter_remove_webhook_from_monitor(webhook_id)
|
|
3298
|
+
|
|
3299
|
+
Remove webhook from monitor
|
|
3300
|
+
|
|
3301
|
+
Remove webhook configuration from a monitor. webhook_id is the monitor_id.
|
|
3302
|
+
|
|
3303
|
+
### Examples
|
|
3304
|
+
|
|
3305
|
+
```ruby
|
|
3306
|
+
require 'time'
|
|
3307
|
+
require 'scrapebadger'
|
|
3308
|
+
# setup authorization
|
|
3309
|
+
ScrapeBadger.configure do |config|
|
|
3310
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3311
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3312
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3313
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3314
|
+
end
|
|
3315
|
+
|
|
3316
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3317
|
+
webhook_id = 'webhook_id_example' # String |
|
|
3318
|
+
|
|
3319
|
+
begin
|
|
3320
|
+
# Remove webhook from monitor
|
|
3321
|
+
api_instance.twitter_remove_webhook_from_monitor(webhook_id)
|
|
3322
|
+
rescue ScrapeBadger::ApiError => e
|
|
3323
|
+
puts "Error when calling TwitterApi->twitter_remove_webhook_from_monitor: #{e}"
|
|
3324
|
+
end
|
|
3325
|
+
```
|
|
3326
|
+
|
|
3327
|
+
#### Using the twitter_remove_webhook_from_monitor_with_http_info variant
|
|
3328
|
+
|
|
3329
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
3330
|
+
|
|
3331
|
+
> <Array(nil, Integer, Hash)> twitter_remove_webhook_from_monitor_with_http_info(webhook_id)
|
|
3332
|
+
|
|
3333
|
+
```ruby
|
|
3334
|
+
begin
|
|
3335
|
+
# Remove webhook from monitor
|
|
3336
|
+
data, status_code, headers = api_instance.twitter_remove_webhook_from_monitor_with_http_info(webhook_id)
|
|
3337
|
+
p status_code # => 2xx
|
|
3338
|
+
p headers # => { ... }
|
|
3339
|
+
p data # => nil
|
|
3340
|
+
rescue ScrapeBadger::ApiError => e
|
|
3341
|
+
puts "Error when calling TwitterApi->twitter_remove_webhook_from_monitor_with_http_info: #{e}"
|
|
3342
|
+
end
|
|
3343
|
+
```
|
|
3344
|
+
|
|
3345
|
+
### Parameters
|
|
3346
|
+
|
|
3347
|
+
| Name | Type | Description | Notes |
|
|
3348
|
+
| ---- | ---- | ----------- | ----- |
|
|
3349
|
+
| **webhook_id** | **String** | | |
|
|
3350
|
+
|
|
3351
|
+
### Return type
|
|
3352
|
+
|
|
3353
|
+
nil (empty response body)
|
|
3354
|
+
|
|
3355
|
+
### Authorization
|
|
3356
|
+
|
|
3357
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3358
|
+
|
|
3359
|
+
### HTTP request headers
|
|
3360
|
+
|
|
3361
|
+
- **Content-Type**: Not defined
|
|
3362
|
+
- **Accept**: application/json
|
|
3363
|
+
|
|
3364
|
+
|
|
3365
|
+
## twitter_search_communities
|
|
3366
|
+
|
|
3367
|
+
> Object twitter_search_communities(query, opts)
|
|
3368
|
+
|
|
3369
|
+
Search communities
|
|
3370
|
+
|
|
3371
|
+
Search for communities by query.
|
|
3372
|
+
|
|
3373
|
+
### Examples
|
|
3374
|
+
|
|
3375
|
+
```ruby
|
|
3376
|
+
require 'time'
|
|
3377
|
+
require 'scrapebadger'
|
|
3378
|
+
# setup authorization
|
|
3379
|
+
ScrapeBadger.configure do |config|
|
|
3380
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3381
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3382
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3383
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3384
|
+
end
|
|
3385
|
+
|
|
3386
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3387
|
+
query = 'query_example' # String |
|
|
3388
|
+
opts = {
|
|
3389
|
+
cursor: 'cursor_example' # String |
|
|
3390
|
+
}
|
|
3391
|
+
|
|
3392
|
+
begin
|
|
3393
|
+
# Search communities
|
|
3394
|
+
result = api_instance.twitter_search_communities(query, opts)
|
|
3395
|
+
p result
|
|
3396
|
+
rescue ScrapeBadger::ApiError => e
|
|
3397
|
+
puts "Error when calling TwitterApi->twitter_search_communities: #{e}"
|
|
3398
|
+
end
|
|
3399
|
+
```
|
|
3400
|
+
|
|
3401
|
+
#### Using the twitter_search_communities_with_http_info variant
|
|
3402
|
+
|
|
3403
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3404
|
+
|
|
3405
|
+
> <Array(Object, Integer, Hash)> twitter_search_communities_with_http_info(query, opts)
|
|
3406
|
+
|
|
3407
|
+
```ruby
|
|
3408
|
+
begin
|
|
3409
|
+
# Search communities
|
|
3410
|
+
data, status_code, headers = api_instance.twitter_search_communities_with_http_info(query, opts)
|
|
3411
|
+
p status_code # => 2xx
|
|
3412
|
+
p headers # => { ... }
|
|
3413
|
+
p data # => Object
|
|
3414
|
+
rescue ScrapeBadger::ApiError => e
|
|
3415
|
+
puts "Error when calling TwitterApi->twitter_search_communities_with_http_info: #{e}"
|
|
3416
|
+
end
|
|
3417
|
+
```
|
|
3418
|
+
|
|
3419
|
+
### Parameters
|
|
3420
|
+
|
|
3421
|
+
| Name | Type | Description | Notes |
|
|
3422
|
+
| ---- | ---- | ----------- | ----- |
|
|
3423
|
+
| **query** | **String** | | |
|
|
3424
|
+
| **cursor** | **String** | | [optional] |
|
|
3425
|
+
|
|
3426
|
+
### Return type
|
|
3427
|
+
|
|
3428
|
+
**Object**
|
|
3429
|
+
|
|
3430
|
+
### Authorization
|
|
3431
|
+
|
|
3432
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3433
|
+
|
|
3434
|
+
### HTTP request headers
|
|
3435
|
+
|
|
3436
|
+
- **Content-Type**: Not defined
|
|
3437
|
+
- **Accept**: application/json
|
|
3438
|
+
|
|
3439
|
+
|
|
3440
|
+
## twitter_search_list_tweets
|
|
3441
|
+
|
|
3442
|
+
> Object twitter_search_list_tweets(list_id, query, opts)
|
|
3443
|
+
|
|
3444
|
+
Search list tweets
|
|
3445
|
+
|
|
3446
|
+
Search tweets within a specific list.
|
|
3447
|
+
|
|
3448
|
+
### Examples
|
|
3449
|
+
|
|
3450
|
+
```ruby
|
|
3451
|
+
require 'time'
|
|
3452
|
+
require 'scrapebadger'
|
|
3453
|
+
# setup authorization
|
|
3454
|
+
ScrapeBadger.configure do |config|
|
|
3455
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3456
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3457
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3458
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3459
|
+
end
|
|
3460
|
+
|
|
3461
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3462
|
+
list_id = 'list_id_example' # String |
|
|
3463
|
+
query = 'query_example' # String |
|
|
3464
|
+
opts = {
|
|
3465
|
+
cursor: 'cursor_example' # String |
|
|
3466
|
+
}
|
|
3467
|
+
|
|
3468
|
+
begin
|
|
3469
|
+
# Search list tweets
|
|
3470
|
+
result = api_instance.twitter_search_list_tweets(list_id, query, opts)
|
|
3471
|
+
p result
|
|
3472
|
+
rescue ScrapeBadger::ApiError => e
|
|
3473
|
+
puts "Error when calling TwitterApi->twitter_search_list_tweets: #{e}"
|
|
3474
|
+
end
|
|
3475
|
+
```
|
|
3476
|
+
|
|
3477
|
+
#### Using the twitter_search_list_tweets_with_http_info variant
|
|
3478
|
+
|
|
3479
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3480
|
+
|
|
3481
|
+
> <Array(Object, Integer, Hash)> twitter_search_list_tweets_with_http_info(list_id, query, opts)
|
|
3482
|
+
|
|
3483
|
+
```ruby
|
|
3484
|
+
begin
|
|
3485
|
+
# Search list tweets
|
|
3486
|
+
data, status_code, headers = api_instance.twitter_search_list_tweets_with_http_info(list_id, query, opts)
|
|
3487
|
+
p status_code # => 2xx
|
|
3488
|
+
p headers # => { ... }
|
|
3489
|
+
p data # => Object
|
|
3490
|
+
rescue ScrapeBadger::ApiError => e
|
|
3491
|
+
puts "Error when calling TwitterApi->twitter_search_list_tweets_with_http_info: #{e}"
|
|
3492
|
+
end
|
|
3493
|
+
```
|
|
3494
|
+
|
|
3495
|
+
### Parameters
|
|
3496
|
+
|
|
3497
|
+
| Name | Type | Description | Notes |
|
|
3498
|
+
| ---- | ---- | ----------- | ----- |
|
|
3499
|
+
| **list_id** | **String** | | |
|
|
3500
|
+
| **query** | **String** | | |
|
|
3501
|
+
| **cursor** | **String** | | [optional] |
|
|
3502
|
+
|
|
3503
|
+
### Return type
|
|
3504
|
+
|
|
3505
|
+
**Object**
|
|
3506
|
+
|
|
3507
|
+
### Authorization
|
|
3508
|
+
|
|
3509
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3510
|
+
|
|
3511
|
+
### HTTP request headers
|
|
3512
|
+
|
|
3513
|
+
- **Content-Type**: Not defined
|
|
3514
|
+
- **Accept**: application/json
|
|
3515
|
+
|
|
3516
|
+
|
|
3517
|
+
## twitter_search_places
|
|
3518
|
+
|
|
3519
|
+
> Object twitter_search_places(opts)
|
|
3520
|
+
|
|
3521
|
+
Search places
|
|
3522
|
+
|
|
3523
|
+
Search for places by query or coordinates.
|
|
3524
|
+
|
|
3525
|
+
### Examples
|
|
3526
|
+
|
|
3527
|
+
```ruby
|
|
3528
|
+
require 'time'
|
|
3529
|
+
require 'scrapebadger'
|
|
3530
|
+
# setup authorization
|
|
3531
|
+
ScrapeBadger.configure do |config|
|
|
3532
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3533
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3534
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3535
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3536
|
+
end
|
|
3537
|
+
|
|
3538
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3539
|
+
opts = {
|
|
3540
|
+
query: 'query_example', # String |
|
|
3541
|
+
lat: 8.14, # Float |
|
|
3542
|
+
long: 8.14 # Float |
|
|
3543
|
+
}
|
|
3544
|
+
|
|
3545
|
+
begin
|
|
3546
|
+
# Search places
|
|
3547
|
+
result = api_instance.twitter_search_places(opts)
|
|
3548
|
+
p result
|
|
3549
|
+
rescue ScrapeBadger::ApiError => e
|
|
3550
|
+
puts "Error when calling TwitterApi->twitter_search_places: #{e}"
|
|
3551
|
+
end
|
|
3552
|
+
```
|
|
3553
|
+
|
|
3554
|
+
#### Using the twitter_search_places_with_http_info variant
|
|
3555
|
+
|
|
3556
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3557
|
+
|
|
3558
|
+
> <Array(Object, Integer, Hash)> twitter_search_places_with_http_info(opts)
|
|
3559
|
+
|
|
3560
|
+
```ruby
|
|
3561
|
+
begin
|
|
3562
|
+
# Search places
|
|
3563
|
+
data, status_code, headers = api_instance.twitter_search_places_with_http_info(opts)
|
|
3564
|
+
p status_code # => 2xx
|
|
3565
|
+
p headers # => { ... }
|
|
3566
|
+
p data # => Object
|
|
3567
|
+
rescue ScrapeBadger::ApiError => e
|
|
3568
|
+
puts "Error when calling TwitterApi->twitter_search_places_with_http_info: #{e}"
|
|
3569
|
+
end
|
|
3570
|
+
```
|
|
3571
|
+
|
|
3572
|
+
### Parameters
|
|
3573
|
+
|
|
3574
|
+
| Name | Type | Description | Notes |
|
|
3575
|
+
| ---- | ---- | ----------- | ----- |
|
|
3576
|
+
| **query** | **String** | | [optional] |
|
|
3577
|
+
| **lat** | **Float** | | [optional] |
|
|
3578
|
+
| **long** | **Float** | | [optional] |
|
|
3579
|
+
|
|
3580
|
+
### Return type
|
|
3581
|
+
|
|
3582
|
+
**Object**
|
|
3583
|
+
|
|
3584
|
+
### Authorization
|
|
3585
|
+
|
|
3586
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3587
|
+
|
|
3588
|
+
### HTTP request headers
|
|
3589
|
+
|
|
3590
|
+
- **Content-Type**: Not defined
|
|
3591
|
+
- **Accept**: application/json
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
## twitter_search_users
|
|
3595
|
+
|
|
3596
|
+
> Object twitter_search_users(query, opts)
|
|
3597
|
+
|
|
3598
|
+
Search users
|
|
3599
|
+
|
|
3600
|
+
Search for users by query.
|
|
3601
|
+
|
|
3602
|
+
### Examples
|
|
3603
|
+
|
|
3604
|
+
```ruby
|
|
3605
|
+
require 'time'
|
|
3606
|
+
require 'scrapebadger'
|
|
3607
|
+
# setup authorization
|
|
3608
|
+
ScrapeBadger.configure do |config|
|
|
3609
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3610
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3611
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3612
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3613
|
+
end
|
|
3614
|
+
|
|
3615
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3616
|
+
query = 'query_example' # String |
|
|
3617
|
+
opts = {
|
|
3618
|
+
cursor: 'cursor_example' # String |
|
|
3619
|
+
}
|
|
3620
|
+
|
|
3621
|
+
begin
|
|
3622
|
+
# Search users
|
|
3623
|
+
result = api_instance.twitter_search_users(query, opts)
|
|
3624
|
+
p result
|
|
3625
|
+
rescue ScrapeBadger::ApiError => e
|
|
3626
|
+
puts "Error when calling TwitterApi->twitter_search_users: #{e}"
|
|
3627
|
+
end
|
|
3628
|
+
```
|
|
3629
|
+
|
|
3630
|
+
#### Using the twitter_search_users_with_http_info variant
|
|
3631
|
+
|
|
3632
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3633
|
+
|
|
3634
|
+
> <Array(Object, Integer, Hash)> twitter_search_users_with_http_info(query, opts)
|
|
3635
|
+
|
|
3636
|
+
```ruby
|
|
3637
|
+
begin
|
|
3638
|
+
# Search users
|
|
3639
|
+
data, status_code, headers = api_instance.twitter_search_users_with_http_info(query, opts)
|
|
3640
|
+
p status_code # => 2xx
|
|
3641
|
+
p headers # => { ... }
|
|
3642
|
+
p data # => Object
|
|
3643
|
+
rescue ScrapeBadger::ApiError => e
|
|
3644
|
+
puts "Error when calling TwitterApi->twitter_search_users_with_http_info: #{e}"
|
|
3645
|
+
end
|
|
3646
|
+
```
|
|
3647
|
+
|
|
3648
|
+
### Parameters
|
|
3649
|
+
|
|
3650
|
+
| Name | Type | Description | Notes |
|
|
3651
|
+
| ---- | ---- | ----------- | ----- |
|
|
3652
|
+
| **query** | **String** | | |
|
|
3653
|
+
| **cursor** | **String** | | [optional] |
|
|
3654
|
+
|
|
3655
|
+
### Return type
|
|
3656
|
+
|
|
3657
|
+
**Object**
|
|
3658
|
+
|
|
3659
|
+
### Authorization
|
|
3660
|
+
|
|
3661
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3662
|
+
|
|
3663
|
+
### HTTP request headers
|
|
3664
|
+
|
|
3665
|
+
- **Content-Type**: Not defined
|
|
3666
|
+
- **Accept**: application/json
|
|
3667
|
+
|
|
3668
|
+
|
|
3669
|
+
## twitter_test_webhook_delivery
|
|
3670
|
+
|
|
3671
|
+
> <WebhookTestResponse> twitter_test_webhook_delivery(webhook_test_request)
|
|
3672
|
+
|
|
3673
|
+
Test webhook delivery
|
|
3674
|
+
|
|
3675
|
+
Send a test payload to a monitor's webhook URL. The test payload has type=\"test\" instead of type=\"tweet\". Makes a synchronous HTTP POST and returns the delivery result.
|
|
3676
|
+
|
|
3677
|
+
### Examples
|
|
3678
|
+
|
|
3679
|
+
```ruby
|
|
3680
|
+
require 'time'
|
|
3681
|
+
require 'scrapebadger'
|
|
3682
|
+
# setup authorization
|
|
3683
|
+
ScrapeBadger.configure do |config|
|
|
3684
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3685
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3686
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3687
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3688
|
+
end
|
|
3689
|
+
|
|
3690
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3691
|
+
webhook_test_request = ScrapeBadger::WebhookTestRequest.new({monitor_id: 'monitor_id_example'}) # WebhookTestRequest |
|
|
3692
|
+
|
|
3693
|
+
begin
|
|
3694
|
+
# Test webhook delivery
|
|
3695
|
+
result = api_instance.twitter_test_webhook_delivery(webhook_test_request)
|
|
3696
|
+
p result
|
|
3697
|
+
rescue ScrapeBadger::ApiError => e
|
|
3698
|
+
puts "Error when calling TwitterApi->twitter_test_webhook_delivery: #{e}"
|
|
3699
|
+
end
|
|
3700
|
+
```
|
|
3701
|
+
|
|
3702
|
+
#### Using the twitter_test_webhook_delivery_with_http_info variant
|
|
3703
|
+
|
|
3704
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3705
|
+
|
|
3706
|
+
> <Array(<WebhookTestResponse>, Integer, Hash)> twitter_test_webhook_delivery_with_http_info(webhook_test_request)
|
|
3707
|
+
|
|
3708
|
+
```ruby
|
|
3709
|
+
begin
|
|
3710
|
+
# Test webhook delivery
|
|
3711
|
+
data, status_code, headers = api_instance.twitter_test_webhook_delivery_with_http_info(webhook_test_request)
|
|
3712
|
+
p status_code # => 2xx
|
|
3713
|
+
p headers # => { ... }
|
|
3714
|
+
p data # => <WebhookTestResponse>
|
|
3715
|
+
rescue ScrapeBadger::ApiError => e
|
|
3716
|
+
puts "Error when calling TwitterApi->twitter_test_webhook_delivery_with_http_info: #{e}"
|
|
3717
|
+
end
|
|
3718
|
+
```
|
|
3719
|
+
|
|
3720
|
+
### Parameters
|
|
3721
|
+
|
|
3722
|
+
| Name | Type | Description | Notes |
|
|
3723
|
+
| ---- | ---- | ----------- | ----- |
|
|
3724
|
+
| **webhook_test_request** | [**WebhookTestRequest**](WebhookTestRequest.md) | | |
|
|
3725
|
+
|
|
3726
|
+
### Return type
|
|
3727
|
+
|
|
3728
|
+
[**WebhookTestResponse**](WebhookTestResponse.md)
|
|
3729
|
+
|
|
3730
|
+
### Authorization
|
|
3731
|
+
|
|
3732
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3733
|
+
|
|
3734
|
+
### HTTP request headers
|
|
3735
|
+
|
|
3736
|
+
- **Content-Type**: application/json
|
|
3737
|
+
- **Accept**: application/json
|
|
3738
|
+
|
|
3739
|
+
|
|
3740
|
+
## twitter_twitter_scraper_health_check
|
|
3741
|
+
|
|
3742
|
+
> Object twitter_twitter_scraper_health_check
|
|
3743
|
+
|
|
3744
|
+
Twitter scraper health check
|
|
3745
|
+
|
|
3746
|
+
Check health of the Twitter scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.
|
|
3747
|
+
|
|
3748
|
+
### Examples
|
|
3749
|
+
|
|
3750
|
+
```ruby
|
|
3751
|
+
require 'time'
|
|
3752
|
+
require 'scrapebadger'
|
|
3753
|
+
# setup authorization
|
|
3754
|
+
ScrapeBadger.configure do |config|
|
|
3755
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3756
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3757
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3758
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3759
|
+
end
|
|
3760
|
+
|
|
3761
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3762
|
+
|
|
3763
|
+
begin
|
|
3764
|
+
# Twitter scraper health check
|
|
3765
|
+
result = api_instance.twitter_twitter_scraper_health_check
|
|
3766
|
+
p result
|
|
3767
|
+
rescue ScrapeBadger::ApiError => e
|
|
3768
|
+
puts "Error when calling TwitterApi->twitter_twitter_scraper_health_check: #{e}"
|
|
3769
|
+
end
|
|
3770
|
+
```
|
|
3771
|
+
|
|
3772
|
+
#### Using the twitter_twitter_scraper_health_check_with_http_info variant
|
|
3773
|
+
|
|
3774
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3775
|
+
|
|
3776
|
+
> <Array(Object, Integer, Hash)> twitter_twitter_scraper_health_check_with_http_info
|
|
3777
|
+
|
|
3778
|
+
```ruby
|
|
3779
|
+
begin
|
|
3780
|
+
# Twitter scraper health check
|
|
3781
|
+
data, status_code, headers = api_instance.twitter_twitter_scraper_health_check_with_http_info
|
|
3782
|
+
p status_code # => 2xx
|
|
3783
|
+
p headers # => { ... }
|
|
3784
|
+
p data # => Object
|
|
3785
|
+
rescue ScrapeBadger::ApiError => e
|
|
3786
|
+
puts "Error when calling TwitterApi->twitter_twitter_scraper_health_check_with_http_info: #{e}"
|
|
3787
|
+
end
|
|
3788
|
+
```
|
|
3789
|
+
|
|
3790
|
+
### Parameters
|
|
3791
|
+
|
|
3792
|
+
This endpoint does not need any parameter.
|
|
3793
|
+
|
|
3794
|
+
### Return type
|
|
3795
|
+
|
|
3796
|
+
**Object**
|
|
3797
|
+
|
|
3798
|
+
### Authorization
|
|
3799
|
+
|
|
3800
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3801
|
+
|
|
3802
|
+
### HTTP request headers
|
|
3803
|
+
|
|
3804
|
+
- **Content-Type**: Not defined
|
|
3805
|
+
- **Accept**: application/json
|
|
3806
|
+
|
|
3807
|
+
|
|
3808
|
+
## twitter_twitter_scraper_health_check_head
|
|
3809
|
+
|
|
3810
|
+
> Object twitter_twitter_scraper_health_check_head
|
|
3811
|
+
|
|
3812
|
+
Twitter scraper health check
|
|
3813
|
+
|
|
3814
|
+
Check health of the Twitter scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.
|
|
3815
|
+
|
|
3816
|
+
### Examples
|
|
3817
|
+
|
|
3818
|
+
```ruby
|
|
3819
|
+
require 'time'
|
|
3820
|
+
require 'scrapebadger'
|
|
3821
|
+
# setup authorization
|
|
3822
|
+
ScrapeBadger.configure do |config|
|
|
3823
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3824
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3825
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3826
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3827
|
+
end
|
|
3828
|
+
|
|
3829
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3830
|
+
|
|
3831
|
+
begin
|
|
3832
|
+
# Twitter scraper health check
|
|
3833
|
+
result = api_instance.twitter_twitter_scraper_health_check_head
|
|
3834
|
+
p result
|
|
3835
|
+
rescue ScrapeBadger::ApiError => e
|
|
3836
|
+
puts "Error when calling TwitterApi->twitter_twitter_scraper_health_check_head: #{e}"
|
|
3837
|
+
end
|
|
3838
|
+
```
|
|
3839
|
+
|
|
3840
|
+
#### Using the twitter_twitter_scraper_health_check_head_with_http_info variant
|
|
3841
|
+
|
|
3842
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3843
|
+
|
|
3844
|
+
> <Array(Object, Integer, Hash)> twitter_twitter_scraper_health_check_head_with_http_info
|
|
3845
|
+
|
|
3846
|
+
```ruby
|
|
3847
|
+
begin
|
|
3848
|
+
# Twitter scraper health check
|
|
3849
|
+
data, status_code, headers = api_instance.twitter_twitter_scraper_health_check_head_with_http_info
|
|
3850
|
+
p status_code # => 2xx
|
|
3851
|
+
p headers # => { ... }
|
|
3852
|
+
p data # => Object
|
|
3853
|
+
rescue ScrapeBadger::ApiError => e
|
|
3854
|
+
puts "Error when calling TwitterApi->twitter_twitter_scraper_health_check_head_with_http_info: #{e}"
|
|
3855
|
+
end
|
|
3856
|
+
```
|
|
3857
|
+
|
|
3858
|
+
### Parameters
|
|
3859
|
+
|
|
3860
|
+
This endpoint does not need any parameter.
|
|
3861
|
+
|
|
3862
|
+
### Return type
|
|
3863
|
+
|
|
3864
|
+
**Object**
|
|
3865
|
+
|
|
3866
|
+
### Authorization
|
|
3867
|
+
|
|
3868
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3869
|
+
|
|
3870
|
+
### HTTP request headers
|
|
3871
|
+
|
|
3872
|
+
- **Content-Type**: Not defined
|
|
3873
|
+
- **Accept**: application/json
|
|
3874
|
+
|
|
3875
|
+
|
|
3876
|
+
## twitter_update_filter_rule
|
|
3877
|
+
|
|
3878
|
+
> <FilterRuleResponse> twitter_update_filter_rule(rule_id, filter_rule_update)
|
|
3879
|
+
|
|
3880
|
+
Update filter rule
|
|
3881
|
+
|
|
3882
|
+
Partially update a filter rule. Setting status='active' on a paused rule performs a credit check.
|
|
3883
|
+
|
|
3884
|
+
### Examples
|
|
3885
|
+
|
|
3886
|
+
```ruby
|
|
3887
|
+
require 'time'
|
|
3888
|
+
require 'scrapebadger'
|
|
3889
|
+
# setup authorization
|
|
3890
|
+
ScrapeBadger.configure do |config|
|
|
3891
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3892
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3893
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3894
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3895
|
+
end
|
|
3896
|
+
|
|
3897
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3898
|
+
rule_id = 'rule_id_example' # String |
|
|
3899
|
+
filter_rule_update = ScrapeBadger::FilterRuleUpdate.new # FilterRuleUpdate |
|
|
3900
|
+
|
|
3901
|
+
begin
|
|
3902
|
+
# Update filter rule
|
|
3903
|
+
result = api_instance.twitter_update_filter_rule(rule_id, filter_rule_update)
|
|
3904
|
+
p result
|
|
3905
|
+
rescue ScrapeBadger::ApiError => e
|
|
3906
|
+
puts "Error when calling TwitterApi->twitter_update_filter_rule: #{e}"
|
|
3907
|
+
end
|
|
3908
|
+
```
|
|
3909
|
+
|
|
3910
|
+
#### Using the twitter_update_filter_rule_with_http_info variant
|
|
3911
|
+
|
|
3912
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3913
|
+
|
|
3914
|
+
> <Array(<FilterRuleResponse>, Integer, Hash)> twitter_update_filter_rule_with_http_info(rule_id, filter_rule_update)
|
|
3915
|
+
|
|
3916
|
+
```ruby
|
|
3917
|
+
begin
|
|
3918
|
+
# Update filter rule
|
|
3919
|
+
data, status_code, headers = api_instance.twitter_update_filter_rule_with_http_info(rule_id, filter_rule_update)
|
|
3920
|
+
p status_code # => 2xx
|
|
3921
|
+
p headers # => { ... }
|
|
3922
|
+
p data # => <FilterRuleResponse>
|
|
3923
|
+
rescue ScrapeBadger::ApiError => e
|
|
3924
|
+
puts "Error when calling TwitterApi->twitter_update_filter_rule_with_http_info: #{e}"
|
|
3925
|
+
end
|
|
3926
|
+
```
|
|
3927
|
+
|
|
3928
|
+
### Parameters
|
|
3929
|
+
|
|
3930
|
+
| Name | Type | Description | Notes |
|
|
3931
|
+
| ---- | ---- | ----------- | ----- |
|
|
3932
|
+
| **rule_id** | **String** | | |
|
|
3933
|
+
| **filter_rule_update** | [**FilterRuleUpdate**](FilterRuleUpdate.md) | | |
|
|
3934
|
+
|
|
3935
|
+
### Return type
|
|
3936
|
+
|
|
3937
|
+
[**FilterRuleResponse**](FilterRuleResponse.md)
|
|
3938
|
+
|
|
3939
|
+
### Authorization
|
|
3940
|
+
|
|
3941
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
3942
|
+
|
|
3943
|
+
### HTTP request headers
|
|
3944
|
+
|
|
3945
|
+
- **Content-Type**: application/json
|
|
3946
|
+
- **Accept**: application/json
|
|
3947
|
+
|
|
3948
|
+
|
|
3949
|
+
## twitter_update_stream_monitor
|
|
3950
|
+
|
|
3951
|
+
> <StreamMonitorResponse> twitter_update_stream_monitor(monitor_id, stream_monitor_update)
|
|
3952
|
+
|
|
3953
|
+
Update stream monitor
|
|
3954
|
+
|
|
3955
|
+
Partially update a stream monitor.
|
|
3956
|
+
|
|
3957
|
+
### Examples
|
|
3958
|
+
|
|
3959
|
+
```ruby
|
|
3960
|
+
require 'time'
|
|
3961
|
+
require 'scrapebadger'
|
|
3962
|
+
# setup authorization
|
|
3963
|
+
ScrapeBadger.configure do |config|
|
|
3964
|
+
# Configure API key authorization: ApiKeyAuth
|
|
3965
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
3966
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3967
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
3968
|
+
end
|
|
3969
|
+
|
|
3970
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
3971
|
+
monitor_id = 'monitor_id_example' # String |
|
|
3972
|
+
stream_monitor_update = ScrapeBadger::StreamMonitorUpdate.new # StreamMonitorUpdate |
|
|
3973
|
+
|
|
3974
|
+
begin
|
|
3975
|
+
# Update stream monitor
|
|
3976
|
+
result = api_instance.twitter_update_stream_monitor(monitor_id, stream_monitor_update)
|
|
3977
|
+
p result
|
|
3978
|
+
rescue ScrapeBadger::ApiError => e
|
|
3979
|
+
puts "Error when calling TwitterApi->twitter_update_stream_monitor: #{e}"
|
|
3980
|
+
end
|
|
3981
|
+
```
|
|
3982
|
+
|
|
3983
|
+
#### Using the twitter_update_stream_monitor_with_http_info variant
|
|
3984
|
+
|
|
3985
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3986
|
+
|
|
3987
|
+
> <Array(<StreamMonitorResponse>, Integer, Hash)> twitter_update_stream_monitor_with_http_info(monitor_id, stream_monitor_update)
|
|
3988
|
+
|
|
3989
|
+
```ruby
|
|
3990
|
+
begin
|
|
3991
|
+
# Update stream monitor
|
|
3992
|
+
data, status_code, headers = api_instance.twitter_update_stream_monitor_with_http_info(monitor_id, stream_monitor_update)
|
|
3993
|
+
p status_code # => 2xx
|
|
3994
|
+
p headers # => { ... }
|
|
3995
|
+
p data # => <StreamMonitorResponse>
|
|
3996
|
+
rescue ScrapeBadger::ApiError => e
|
|
3997
|
+
puts "Error when calling TwitterApi->twitter_update_stream_monitor_with_http_info: #{e}"
|
|
3998
|
+
end
|
|
3999
|
+
```
|
|
4000
|
+
|
|
4001
|
+
### Parameters
|
|
4002
|
+
|
|
4003
|
+
| Name | Type | Description | Notes |
|
|
4004
|
+
| ---- | ---- | ----------- | ----- |
|
|
4005
|
+
| **monitor_id** | **String** | | |
|
|
4006
|
+
| **stream_monitor_update** | [**StreamMonitorUpdate**](StreamMonitorUpdate.md) | | |
|
|
4007
|
+
|
|
4008
|
+
### Return type
|
|
4009
|
+
|
|
4010
|
+
[**StreamMonitorResponse**](StreamMonitorResponse.md)
|
|
4011
|
+
|
|
4012
|
+
### Authorization
|
|
4013
|
+
|
|
4014
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
4015
|
+
|
|
4016
|
+
### HTTP request headers
|
|
4017
|
+
|
|
4018
|
+
- **Content-Type**: application/json
|
|
4019
|
+
- **Accept**: application/json
|
|
4020
|
+
|
|
4021
|
+
|
|
4022
|
+
## twitter_validate_search_query
|
|
4023
|
+
|
|
4024
|
+
> <FilterRuleValidateResponse> twitter_validate_search_query(filter_rule_validate_request)
|
|
4025
|
+
|
|
4026
|
+
Validate search query
|
|
4027
|
+
|
|
4028
|
+
Validate a Twitter search query string. Performs basic structural validation without making a live Twitter request. Returns valid=True if the query passes syntax checks.
|
|
4029
|
+
|
|
4030
|
+
### Examples
|
|
4031
|
+
|
|
4032
|
+
```ruby
|
|
4033
|
+
require 'time'
|
|
4034
|
+
require 'scrapebadger'
|
|
4035
|
+
# setup authorization
|
|
4036
|
+
ScrapeBadger.configure do |config|
|
|
4037
|
+
# Configure API key authorization: ApiKeyAuth
|
|
4038
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
4039
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4040
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
4041
|
+
end
|
|
4042
|
+
|
|
4043
|
+
api_instance = ScrapeBadger::TwitterApi.new
|
|
4044
|
+
filter_rule_validate_request = ScrapeBadger::FilterRuleValidateRequest.new({query: 'query_example'}) # FilterRuleValidateRequest |
|
|
4045
|
+
|
|
4046
|
+
begin
|
|
4047
|
+
# Validate search query
|
|
4048
|
+
result = api_instance.twitter_validate_search_query(filter_rule_validate_request)
|
|
4049
|
+
p result
|
|
4050
|
+
rescue ScrapeBadger::ApiError => e
|
|
4051
|
+
puts "Error when calling TwitterApi->twitter_validate_search_query: #{e}"
|
|
4052
|
+
end
|
|
4053
|
+
```
|
|
4054
|
+
|
|
4055
|
+
#### Using the twitter_validate_search_query_with_http_info variant
|
|
4056
|
+
|
|
4057
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4058
|
+
|
|
4059
|
+
> <Array(<FilterRuleValidateResponse>, Integer, Hash)> twitter_validate_search_query_with_http_info(filter_rule_validate_request)
|
|
4060
|
+
|
|
4061
|
+
```ruby
|
|
4062
|
+
begin
|
|
4063
|
+
# Validate search query
|
|
4064
|
+
data, status_code, headers = api_instance.twitter_validate_search_query_with_http_info(filter_rule_validate_request)
|
|
4065
|
+
p status_code # => 2xx
|
|
4066
|
+
p headers # => { ... }
|
|
4067
|
+
p data # => <FilterRuleValidateResponse>
|
|
4068
|
+
rescue ScrapeBadger::ApiError => e
|
|
4069
|
+
puts "Error when calling TwitterApi->twitter_validate_search_query_with_http_info: #{e}"
|
|
4070
|
+
end
|
|
4071
|
+
```
|
|
4072
|
+
|
|
4073
|
+
### Parameters
|
|
4074
|
+
|
|
4075
|
+
| Name | Type | Description | Notes |
|
|
4076
|
+
| ---- | ---- | ----------- | ----- |
|
|
4077
|
+
| **filter_rule_validate_request** | [**FilterRuleValidateRequest**](FilterRuleValidateRequest.md) | | |
|
|
4078
|
+
|
|
4079
|
+
### Return type
|
|
4080
|
+
|
|
4081
|
+
[**FilterRuleValidateResponse**](FilterRuleValidateResponse.md)
|
|
4082
|
+
|
|
4083
|
+
### Authorization
|
|
4084
|
+
|
|
4085
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
4086
|
+
|
|
4087
|
+
### HTTP request headers
|
|
4088
|
+
|
|
4089
|
+
- **Content-Type**: application/json
|
|
4090
|
+
- **Accept**: application/json
|
|
4091
|
+
|