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.
Files changed (185) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +21 -0
  4. data/README.md +548 -0
  5. data/Rakefile +10 -0
  6. data/docs/AccountApi.md +76 -0
  7. data/docs/AccountInfo.md +28 -0
  8. data/docs/AmazonApi.md +1244 -0
  9. data/docs/ApartmentsApi.md +373 -0
  10. data/docs/BaiduApi.md +447 -0
  11. data/docs/BillingLogListResponse.md +24 -0
  12. data/docs/BillingLogResponse.md +32 -0
  13. data/docs/BingApi.md +610 -0
  14. data/docs/ChatGPTApi.md +521 -0
  15. data/docs/DepopApi.md +542 -0
  16. data/docs/DuckDuckGoApi.md +700 -0
  17. data/docs/EBayApi.md +1019 -0
  18. data/docs/FacebookApi.md +1671 -0
  19. data/docs/FilterRuleCreate.md +28 -0
  20. data/docs/FilterRuleDeliveryLogListResponse.md +24 -0
  21. data/docs/FilterRuleDeliveryLogResponse.md +44 -0
  22. data/docs/FilterRuleListResponse.md +24 -0
  23. data/docs/FilterRuleResponse.md +40 -0
  24. data/docs/FilterRuleUpdate.md +30 -0
  25. data/docs/FilterRuleValidateRequest.md +18 -0
  26. data/docs/FilterRuleValidateResponse.md +22 -0
  27. data/docs/GoogleApi.md +3175 -0
  28. data/docs/HTTPValidationError.md +18 -0
  29. data/docs/IdealistaApi.md +822 -0
  30. data/docs/ImmobiliareApi.md +773 -0
  31. data/docs/InstagramApi.md +1673 -0
  32. data/docs/LeboncoinApi.md +884 -0
  33. data/docs/LinkedInApi.md +925 -0
  34. data/docs/LoopNetApi.md +529 -0
  35. data/docs/PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md +20 -0
  36. data/docs/RealtorApi.md +474 -0
  37. data/docs/RedditApi.md +1677 -0
  38. data/docs/RedfinApi.md +616 -0
  39. data/docs/StreamMonitorCreate.md +26 -0
  40. data/docs/StreamMonitorListResponse.md +24 -0
  41. data/docs/StreamMonitorResponse.md +42 -0
  42. data/docs/StreamMonitorUpdate.md +28 -0
  43. data/docs/SubscriptionInfo.md +40 -0
  44. data/docs/TikTokApi.md +2104 -0
  45. data/docs/TweetDeliveryLogListResponse.md +24 -0
  46. data/docs/TweetDeliveryLogResponse.md +44 -0
  47. data/docs/TwitterApi.md +4091 -0
  48. data/docs/ValidationError.md +22 -0
  49. data/docs/ValidationErrorLocInner.md +15 -0
  50. data/docs/VintedApi.md +766 -0
  51. data/docs/WalmartApi.md +904 -0
  52. data/docs/WebApi.md +634 -0
  53. data/docs/WebhookCreate.md +22 -0
  54. data/docs/WebhookListItem.md +28 -0
  55. data/docs/WebhookListResponse.md +20 -0
  56. data/docs/WebhookResponse.md +26 -0
  57. data/docs/WebhookTestRequest.md +18 -0
  58. data/docs/WebhookTestResponse.md +24 -0
  59. data/docs/YahooApi.md +602 -0
  60. data/docs/YandexApi.md +450 -0
  61. data/docs/YouTubeApi.md +2872 -0
  62. data/docs/ZillowApi.md +622 -0
  63. data/git_push.sh +57 -0
  64. data/lib/scrapebadger/api/account_api.rb +79 -0
  65. data/lib/scrapebadger/api/amazon_api.rb +1165 -0
  66. data/lib/scrapebadger/api/apartments_api.rb +377 -0
  67. data/lib/scrapebadger/api/baidu_api.rb +436 -0
  68. data/lib/scrapebadger/api/bing_api.rb +580 -0
  69. data/lib/scrapebadger/api/chat_gpt_api.rb +466 -0
  70. data/lib/scrapebadger/api/depop_api.rb +518 -0
  71. data/lib/scrapebadger/api/duck_duck_go_api.rb +675 -0
  72. data/lib/scrapebadger/api/e_bay_api.rb +1029 -0
  73. data/lib/scrapebadger/api/facebook_api.rb +1492 -0
  74. data/lib/scrapebadger/api/google_api.rb +3191 -0
  75. data/lib/scrapebadger/api/idealista_api.rb +864 -0
  76. data/lib/scrapebadger/api/immobiliare_api.rb +734 -0
  77. data/lib/scrapebadger/api/instagram_api.rb +1555 -0
  78. data/lib/scrapebadger/api/leboncoin_api.rb +818 -0
  79. data/lib/scrapebadger/api/linked_in_api.rb +832 -0
  80. data/lib/scrapebadger/api/loop_net_api.rb +503 -0
  81. data/lib/scrapebadger/api/realtor_api.rb +481 -0
  82. data/lib/scrapebadger/api/reddit_api.rb +1601 -0
  83. data/lib/scrapebadger/api/redfin_api.rb +625 -0
  84. data/lib/scrapebadger/api/tik_tok_api.rb +2029 -0
  85. data/lib/scrapebadger/api/twitter_api.rb +3696 -0
  86. data/lib/scrapebadger/api/vinted_api.rb +705 -0
  87. data/lib/scrapebadger/api/walmart_api.rb +876 -0
  88. data/lib/scrapebadger/api/web_api.rb +547 -0
  89. data/lib/scrapebadger/api/yahoo_api.rb +560 -0
  90. data/lib/scrapebadger/api/yandex_api.rb +422 -0
  91. data/lib/scrapebadger/api/you_tube_api.rb +2520 -0
  92. data/lib/scrapebadger/api/zillow_api.rb +634 -0
  93. data/lib/scrapebadger/api_client.rb +394 -0
  94. data/lib/scrapebadger/api_error.rb +58 -0
  95. data/lib/scrapebadger/configuration.rb +308 -0
  96. data/lib/scrapebadger/models/account_info.rb +288 -0
  97. data/lib/scrapebadger/models/billing_log_list_response.rb +272 -0
  98. data/lib/scrapebadger/models/billing_log_response.rb +334 -0
  99. data/lib/scrapebadger/models/filter_rule_create.rb +427 -0
  100. data/lib/scrapebadger/models/filter_rule_delivery_log_list_response.rb +272 -0
  101. data/lib/scrapebadger/models/filter_rule_delivery_log_response.rb +422 -0
  102. data/lib/scrapebadger/models/filter_rule_list_response.rb +272 -0
  103. data/lib/scrapebadger/models/filter_rule_response.rb +390 -0
  104. data/lib/scrapebadger/models/filter_rule_update.rb +389 -0
  105. data/lib/scrapebadger/models/filter_rule_validate_request.rb +250 -0
  106. data/lib/scrapebadger/models/filter_rule_validate_response.rb +248 -0
  107. data/lib/scrapebadger/models/http_validation_error.rb +216 -0
  108. data/lib/scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response.rb +238 -0
  109. data/lib/scrapebadger/models/stream_monitor_create.rb +373 -0
  110. data/lib/scrapebadger/models/stream_monitor_list_response.rb +272 -0
  111. data/lib/scrapebadger/models/stream_monitor_response.rb +406 -0
  112. data/lib/scrapebadger/models/stream_monitor_update.rb +335 -0
  113. data/lib/scrapebadger/models/subscription_info.rb +352 -0
  114. data/lib/scrapebadger/models/tweet_delivery_log_list_response.rb +272 -0
  115. data/lib/scrapebadger/models/tweet_delivery_log_response.rb +422 -0
  116. data/lib/scrapebadger/models/validation_error.rb +255 -0
  117. data/lib/scrapebadger/models/validation_error_loc_inner.rb +104 -0
  118. data/lib/scrapebadger/models/webhook_create.rb +282 -0
  119. data/lib/scrapebadger/models/webhook_list_item.rb +302 -0
  120. data/lib/scrapebadger/models/webhook_list_response.rb +240 -0
  121. data/lib/scrapebadger/models/webhook_response.rb +286 -0
  122. data/lib/scrapebadger/models/webhook_test_request.rb +223 -0
  123. data/lib/scrapebadger/models/webhook_test_response.rb +259 -0
  124. data/lib/scrapebadger/version.rb +15 -0
  125. data/lib/scrapebadger.rb +96 -0
  126. data/scrapebadger.gemspec +39 -0
  127. data/spec/api/account_api_spec.rb +46 -0
  128. data/spec/api/amazon_api_spec.rb +258 -0
  129. data/spec/api/apartments_api_spec.rb +98 -0
  130. data/spec/api/baidu_api_spec.rb +109 -0
  131. data/spec/api/bing_api_spec.rb +141 -0
  132. data/spec/api/chat_gpt_api_spec.rb +123 -0
  133. data/spec/api/depop_api_spec.rb +132 -0
  134. data/spec/api/duck_duck_go_api_spec.rb +162 -0
  135. data/spec/api/e_bay_api_spec.rb +222 -0
  136. data/spec/api/facebook_api_spec.rb +326 -0
  137. data/spec/api/google_api_spec.rb +649 -0
  138. data/spec/api/idealista_api_spec.rb +197 -0
  139. data/spec/api/immobiliare_api_spec.rb +174 -0
  140. data/spec/api/instagram_api_spec.rb +309 -0
  141. data/spec/api/leboncoin_api_spec.rb +184 -0
  142. data/spec/api/linked_in_api_spec.rb +197 -0
  143. data/spec/api/loop_net_api_spec.rb +127 -0
  144. data/spec/api/realtor_api_spec.rb +123 -0
  145. data/spec/api/reddit_api_spec.rb +331 -0
  146. data/spec/api/redfin_api_spec.rb +147 -0
  147. data/spec/api/tik_tok_api_spec.rb +413 -0
  148. data/spec/api/twitter_api_spec.rb +735 -0
  149. data/spec/api/vinted_api_spec.rb +169 -0
  150. data/spec/api/walmart_api_spec.rb +192 -0
  151. data/spec/api/web_api_spec.rb +136 -0
  152. data/spec/api/yahoo_api_spec.rb +137 -0
  153. data/spec/api/yandex_api_spec.rb +111 -0
  154. data/spec/api/you_tube_api_spec.rb +500 -0
  155. data/spec/api/zillow_api_spec.rb +150 -0
  156. data/spec/models/account_info_spec.rb +66 -0
  157. data/spec/models/billing_log_list_response_spec.rb +54 -0
  158. data/spec/models/billing_log_response_spec.rb +78 -0
  159. data/spec/models/filter_rule_create_spec.rb +66 -0
  160. data/spec/models/filter_rule_delivery_log_list_response_spec.rb +54 -0
  161. data/spec/models/filter_rule_delivery_log_response_spec.rb +114 -0
  162. data/spec/models/filter_rule_list_response_spec.rb +54 -0
  163. data/spec/models/filter_rule_response_spec.rb +102 -0
  164. data/spec/models/filter_rule_update_spec.rb +72 -0
  165. data/spec/models/filter_rule_validate_request_spec.rb +36 -0
  166. data/spec/models/filter_rule_validate_response_spec.rb +48 -0
  167. data/spec/models/http_validation_error_spec.rb +36 -0
  168. data/spec/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response_spec.rb +42 -0
  169. data/spec/models/stream_monitor_create_spec.rb +60 -0
  170. data/spec/models/stream_monitor_list_response_spec.rb +54 -0
  171. data/spec/models/stream_monitor_response_spec.rb +108 -0
  172. data/spec/models/stream_monitor_update_spec.rb +66 -0
  173. data/spec/models/subscription_info_spec.rb +102 -0
  174. data/spec/models/tweet_delivery_log_list_response_spec.rb +54 -0
  175. data/spec/models/tweet_delivery_log_response_spec.rb +114 -0
  176. data/spec/models/validation_error_loc_inner_spec.rb +21 -0
  177. data/spec/models/validation_error_spec.rb +48 -0
  178. data/spec/models/webhook_create_spec.rb +48 -0
  179. data/spec/models/webhook_list_item_spec.rb +66 -0
  180. data/spec/models/webhook_list_response_spec.rb +42 -0
  181. data/spec/models/webhook_response_spec.rb +60 -0
  182. data/spec/models/webhook_test_request_spec.rb +36 -0
  183. data/spec/models/webhook_test_response_spec.rb +54 -0
  184. data/spec/spec_helper.rb +111 -0
  185. metadata +324 -0
data/docs/RedditApi.md ADDED
@@ -0,0 +1,1677 @@
1
+ # ScrapeBadger::RedditApi
2
+
3
+ All URIs are relative to *https://scrapebadger.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**reddit_get_cross_posts**](RedditApi.md#reddit_get_cross_posts) | **GET** /v1/reddit/posts/{post_id}/duplicates | Get cross-posts |
8
+ | [**reddit_get_post_comments**](RedditApi.md#reddit_get_post_comments) | **GET** /v1/reddit/posts/{post_id}/comments | Get post comments |
9
+ | [**reddit_get_post_detail**](RedditApi.md#reddit_get_post_detail) | **GET** /v1/reddit/posts/{post_id} | Get post detail |
10
+ | [**reddit_get_posts_by_domain**](RedditApi.md#reddit_get_posts_by_domain) | **GET** /v1/reddit/domains/{domain}/posts | Get posts by domain |
11
+ | [**reddit_get_subreddit_info**](RedditApi.md#reddit_get_subreddit_info) | **GET** /v1/reddit/subreddits/{subreddit} | Get subreddit info |
12
+ | [**reddit_get_subreddit_posts**](RedditApi.md#reddit_get_subreddit_posts) | **GET** /v1/reddit/subreddits/{subreddit}/posts | Get subreddit posts |
13
+ | [**reddit_get_subreddit_rules**](RedditApi.md#reddit_get_subreddit_rules) | **GET** /v1/reddit/subreddits/{subreddit}/rules | Get subreddit rules |
14
+ | [**reddit_get_trending_posts**](RedditApi.md#reddit_get_trending_posts) | **GET** /v1/reddit/posts/trending | Get trending posts |
15
+ | [**reddit_get_user_profile**](RedditApi.md#reddit_get_user_profile) | **GET** /v1/reddit/users/{username} | Get user profile |
16
+ | [**reddit_get_user_s_comments**](RedditApi.md#reddit_get_user_s_comments) | **GET** /v1/reddit/users/{username}/comments | Get user's comments |
17
+ | [**reddit_get_user_s_moderated_subreddits**](RedditApi.md#reddit_get_user_s_moderated_subreddits) | **GET** /v1/reddit/users/{username}/moderated | Get user's moderated subreddits |
18
+ | [**reddit_get_user_s_posts**](RedditApi.md#reddit_get_user_s_posts) | **GET** /v1/reddit/users/{username}/posts | Get user's posts |
19
+ | [**reddit_get_user_s_trophies**](RedditApi.md#reddit_get_user_s_trophies) | **GET** /v1/reddit/users/{username}/trophies | Get user's trophies |
20
+ | [**reddit_get_wiki_page_content**](RedditApi.md#reddit_get_wiki_page_content) | **GET** /v1/reddit/subreddits/{subreddit}/wiki/{page} | Get wiki page content |
21
+ | [**reddit_list_wiki_pages**](RedditApi.md#reddit_list_wiki_pages) | **GET** /v1/reddit/subreddits/{subreddit}/wiki | List wiki pages |
22
+ | [**reddit_new_subreddits**](RedditApi.md#reddit_new_subreddits) | **GET** /v1/reddit/subreddits/new | New subreddits |
23
+ | [**reddit_popular_subreddits**](RedditApi.md#reddit_popular_subreddits) | **GET** /v1/reddit/subreddits/popular | Popular subreddits |
24
+ | [**reddit_reddit_scraper_health_check**](RedditApi.md#reddit_reddit_scraper_health_check) | **GET** /v1/reddit/health | Reddit scraper health check |
25
+ | [**reddit_reddit_scraper_health_check_head**](RedditApi.md#reddit_reddit_scraper_health_check_head) | **HEAD** /v1/reddit/health | Reddit scraper health check |
26
+ | [**reddit_search_reddit_posts**](RedditApi.md#reddit_search_reddit_posts) | **GET** /v1/reddit/search/posts | Search Reddit posts |
27
+ | [**reddit_search_subreddits**](RedditApi.md#reddit_search_subreddits) | **GET** /v1/reddit/search/subreddits | Search subreddits |
28
+ | [**reddit_search_users**](RedditApi.md#reddit_search_users) | **GET** /v1/reddit/search/users | Search users |
29
+
30
+
31
+ ## reddit_get_cross_posts
32
+
33
+ > Object reddit_get_cross_posts(post_id, opts)
34
+
35
+ Get cross-posts
36
+
37
+ Get cross-posts and duplicates of a Reddit post.
38
+
39
+ ### Examples
40
+
41
+ ```ruby
42
+ require 'time'
43
+ require 'scrapebadger'
44
+ # setup authorization
45
+ ScrapeBadger.configure do |config|
46
+ # Configure API key authorization: ApiKeyAuth
47
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
48
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
49
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
50
+ end
51
+
52
+ api_instance = ScrapeBadger::RedditApi.new
53
+ post_id = 'post_id_example' # String |
54
+ opts = {
55
+ limit: 56, # Integer |
56
+ after: 'after_example' # String |
57
+ }
58
+
59
+ begin
60
+ # Get cross-posts
61
+ result = api_instance.reddit_get_cross_posts(post_id, opts)
62
+ p result
63
+ rescue ScrapeBadger::ApiError => e
64
+ puts "Error when calling RedditApi->reddit_get_cross_posts: #{e}"
65
+ end
66
+ ```
67
+
68
+ #### Using the reddit_get_cross_posts_with_http_info variant
69
+
70
+ This returns an Array which contains the response data, status code and headers.
71
+
72
+ > <Array(Object, Integer, Hash)> reddit_get_cross_posts_with_http_info(post_id, opts)
73
+
74
+ ```ruby
75
+ begin
76
+ # Get cross-posts
77
+ data, status_code, headers = api_instance.reddit_get_cross_posts_with_http_info(post_id, opts)
78
+ p status_code # => 2xx
79
+ p headers # => { ... }
80
+ p data # => Object
81
+ rescue ScrapeBadger::ApiError => e
82
+ puts "Error when calling RedditApi->reddit_get_cross_posts_with_http_info: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ | Name | Type | Description | Notes |
89
+ | ---- | ---- | ----------- | ----- |
90
+ | **post_id** | **String** | | |
91
+ | **limit** | **Integer** | | [optional][default to 25] |
92
+ | **after** | **String** | | [optional] |
93
+
94
+ ### Return type
95
+
96
+ **Object**
97
+
98
+ ### Authorization
99
+
100
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+ ## reddit_get_post_comments
109
+
110
+ > Object reddit_get_post_comments(post_id, opts)
111
+
112
+ Get post comments
113
+
114
+ Get comment tree for a Reddit post.
115
+
116
+ ### Examples
117
+
118
+ ```ruby
119
+ require 'time'
120
+ require 'scrapebadger'
121
+ # setup authorization
122
+ ScrapeBadger.configure do |config|
123
+ # Configure API key authorization: ApiKeyAuth
124
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
125
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
126
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
127
+ end
128
+
129
+ api_instance = ScrapeBadger::RedditApi.new
130
+ post_id = 'post_id_example' # String |
131
+ opts = {
132
+ sort: 'sort_example', # String | Sort: confidence, top, new, controversial, old, qa
133
+ limit: 56, # Integer |
134
+ depth: 56 # Integer |
135
+ }
136
+
137
+ begin
138
+ # Get post comments
139
+ result = api_instance.reddit_get_post_comments(post_id, opts)
140
+ p result
141
+ rescue ScrapeBadger::ApiError => e
142
+ puts "Error when calling RedditApi->reddit_get_post_comments: #{e}"
143
+ end
144
+ ```
145
+
146
+ #### Using the reddit_get_post_comments_with_http_info variant
147
+
148
+ This returns an Array which contains the response data, status code and headers.
149
+
150
+ > <Array(Object, Integer, Hash)> reddit_get_post_comments_with_http_info(post_id, opts)
151
+
152
+ ```ruby
153
+ begin
154
+ # Get post comments
155
+ data, status_code, headers = api_instance.reddit_get_post_comments_with_http_info(post_id, opts)
156
+ p status_code # => 2xx
157
+ p headers # => { ... }
158
+ p data # => Object
159
+ rescue ScrapeBadger::ApiError => e
160
+ puts "Error when calling RedditApi->reddit_get_post_comments_with_http_info: #{e}"
161
+ end
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ | Name | Type | Description | Notes |
167
+ | ---- | ---- | ----------- | ----- |
168
+ | **post_id** | **String** | | |
169
+ | **sort** | **String** | Sort: confidence, top, new, controversial, old, qa | [optional][default to &#39;confidence&#39;] |
170
+ | **limit** | **Integer** | | [optional][default to 25] |
171
+ | **depth** | **Integer** | | [optional] |
172
+
173
+ ### Return type
174
+
175
+ **Object**
176
+
177
+ ### Authorization
178
+
179
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: Not defined
184
+ - **Accept**: application/json
185
+
186
+
187
+ ## reddit_get_post_detail
188
+
189
+ > Object reddit_get_post_detail(post_id)
190
+
191
+ Get post detail
192
+
193
+ Get detailed information about a Reddit post.
194
+
195
+ ### Examples
196
+
197
+ ```ruby
198
+ require 'time'
199
+ require 'scrapebadger'
200
+ # setup authorization
201
+ ScrapeBadger.configure do |config|
202
+ # Configure API key authorization: ApiKeyAuth
203
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
204
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
205
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
206
+ end
207
+
208
+ api_instance = ScrapeBadger::RedditApi.new
209
+ post_id = 'post_id_example' # String |
210
+
211
+ begin
212
+ # Get post detail
213
+ result = api_instance.reddit_get_post_detail(post_id)
214
+ p result
215
+ rescue ScrapeBadger::ApiError => e
216
+ puts "Error when calling RedditApi->reddit_get_post_detail: #{e}"
217
+ end
218
+ ```
219
+
220
+ #### Using the reddit_get_post_detail_with_http_info variant
221
+
222
+ This returns an Array which contains the response data, status code and headers.
223
+
224
+ > <Array(Object, Integer, Hash)> reddit_get_post_detail_with_http_info(post_id)
225
+
226
+ ```ruby
227
+ begin
228
+ # Get post detail
229
+ data, status_code, headers = api_instance.reddit_get_post_detail_with_http_info(post_id)
230
+ p status_code # => 2xx
231
+ p headers # => { ... }
232
+ p data # => Object
233
+ rescue ScrapeBadger::ApiError => e
234
+ puts "Error when calling RedditApi->reddit_get_post_detail_with_http_info: #{e}"
235
+ end
236
+ ```
237
+
238
+ ### Parameters
239
+
240
+ | Name | Type | Description | Notes |
241
+ | ---- | ---- | ----------- | ----- |
242
+ | **post_id** | **String** | | |
243
+
244
+ ### Return type
245
+
246
+ **Object**
247
+
248
+ ### Authorization
249
+
250
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: Not defined
255
+ - **Accept**: application/json
256
+
257
+
258
+ ## reddit_get_posts_by_domain
259
+
260
+ > Object reddit_get_posts_by_domain(domain, opts)
261
+
262
+ Get posts by domain
263
+
264
+ Get Reddit posts linking to a specific domain.
265
+
266
+ ### Examples
267
+
268
+ ```ruby
269
+ require 'time'
270
+ require 'scrapebadger'
271
+ # setup authorization
272
+ ScrapeBadger.configure do |config|
273
+ # Configure API key authorization: ApiKeyAuth
274
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = ScrapeBadger::RedditApi.new
280
+ domain = 'domain_example' # String |
281
+ opts = {
282
+ sort: 'sort_example', # String |
283
+ t: 't_example', # String |
284
+ limit: 56, # Integer |
285
+ after: 'after_example' # String |
286
+ }
287
+
288
+ begin
289
+ # Get posts by domain
290
+ result = api_instance.reddit_get_posts_by_domain(domain, opts)
291
+ p result
292
+ rescue ScrapeBadger::ApiError => e
293
+ puts "Error when calling RedditApi->reddit_get_posts_by_domain: #{e}"
294
+ end
295
+ ```
296
+
297
+ #### Using the reddit_get_posts_by_domain_with_http_info variant
298
+
299
+ This returns an Array which contains the response data, status code and headers.
300
+
301
+ > <Array(Object, Integer, Hash)> reddit_get_posts_by_domain_with_http_info(domain, opts)
302
+
303
+ ```ruby
304
+ begin
305
+ # Get posts by domain
306
+ data, status_code, headers = api_instance.reddit_get_posts_by_domain_with_http_info(domain, opts)
307
+ p status_code # => 2xx
308
+ p headers # => { ... }
309
+ p data # => Object
310
+ rescue ScrapeBadger::ApiError => e
311
+ puts "Error when calling RedditApi->reddit_get_posts_by_domain_with_http_info: #{e}"
312
+ end
313
+ ```
314
+
315
+ ### Parameters
316
+
317
+ | Name | Type | Description | Notes |
318
+ | ---- | ---- | ----------- | ----- |
319
+ | **domain** | **String** | | |
320
+ | **sort** | **String** | | [optional][default to &#39;hot&#39;] |
321
+ | **t** | **String** | | [optional][default to &#39;all&#39;] |
322
+ | **limit** | **Integer** | | [optional][default to 25] |
323
+ | **after** | **String** | | [optional] |
324
+
325
+ ### Return type
326
+
327
+ **Object**
328
+
329
+ ### Authorization
330
+
331
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
332
+
333
+ ### HTTP request headers
334
+
335
+ - **Content-Type**: Not defined
336
+ - **Accept**: application/json
337
+
338
+
339
+ ## reddit_get_subreddit_info
340
+
341
+ > Object reddit_get_subreddit_info(subreddit)
342
+
343
+ Get subreddit info
344
+
345
+ Get detailed information about a subreddit.
346
+
347
+ ### Examples
348
+
349
+ ```ruby
350
+ require 'time'
351
+ require 'scrapebadger'
352
+ # setup authorization
353
+ ScrapeBadger.configure do |config|
354
+ # Configure API key authorization: ApiKeyAuth
355
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
356
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
357
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
358
+ end
359
+
360
+ api_instance = ScrapeBadger::RedditApi.new
361
+ subreddit = 'subreddit_example' # String |
362
+
363
+ begin
364
+ # Get subreddit info
365
+ result = api_instance.reddit_get_subreddit_info(subreddit)
366
+ p result
367
+ rescue ScrapeBadger::ApiError => e
368
+ puts "Error when calling RedditApi->reddit_get_subreddit_info: #{e}"
369
+ end
370
+ ```
371
+
372
+ #### Using the reddit_get_subreddit_info_with_http_info variant
373
+
374
+ This returns an Array which contains the response data, status code and headers.
375
+
376
+ > <Array(Object, Integer, Hash)> reddit_get_subreddit_info_with_http_info(subreddit)
377
+
378
+ ```ruby
379
+ begin
380
+ # Get subreddit info
381
+ data, status_code, headers = api_instance.reddit_get_subreddit_info_with_http_info(subreddit)
382
+ p status_code # => 2xx
383
+ p headers # => { ... }
384
+ p data # => Object
385
+ rescue ScrapeBadger::ApiError => e
386
+ puts "Error when calling RedditApi->reddit_get_subreddit_info_with_http_info: #{e}"
387
+ end
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ | Name | Type | Description | Notes |
393
+ | ---- | ---- | ----------- | ----- |
394
+ | **subreddit** | **String** | | |
395
+
396
+ ### Return type
397
+
398
+ **Object**
399
+
400
+ ### Authorization
401
+
402
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
403
+
404
+ ### HTTP request headers
405
+
406
+ - **Content-Type**: Not defined
407
+ - **Accept**: application/json
408
+
409
+
410
+ ## reddit_get_subreddit_posts
411
+
412
+ > Object reddit_get_subreddit_posts(subreddit, opts)
413
+
414
+ Get subreddit posts
415
+
416
+ Get posts from a subreddit with sorting options.
417
+
418
+ ### Examples
419
+
420
+ ```ruby
421
+ require 'time'
422
+ require 'scrapebadger'
423
+ # setup authorization
424
+ ScrapeBadger.configure do |config|
425
+ # Configure API key authorization: ApiKeyAuth
426
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
427
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
428
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
429
+ end
430
+
431
+ api_instance = ScrapeBadger::RedditApi.new
432
+ subreddit = 'subreddit_example' # String |
433
+ opts = {
434
+ sort: 'sort_example', # String | Sort: hot, new, top, rising, controversial
435
+ t: 't_example', # String | Time filter
436
+ limit: 56, # Integer |
437
+ after: 'after_example' # String |
438
+ }
439
+
440
+ begin
441
+ # Get subreddit posts
442
+ result = api_instance.reddit_get_subreddit_posts(subreddit, opts)
443
+ p result
444
+ rescue ScrapeBadger::ApiError => e
445
+ puts "Error when calling RedditApi->reddit_get_subreddit_posts: #{e}"
446
+ end
447
+ ```
448
+
449
+ #### Using the reddit_get_subreddit_posts_with_http_info variant
450
+
451
+ This returns an Array which contains the response data, status code and headers.
452
+
453
+ > <Array(Object, Integer, Hash)> reddit_get_subreddit_posts_with_http_info(subreddit, opts)
454
+
455
+ ```ruby
456
+ begin
457
+ # Get subreddit posts
458
+ data, status_code, headers = api_instance.reddit_get_subreddit_posts_with_http_info(subreddit, opts)
459
+ p status_code # => 2xx
460
+ p headers # => { ... }
461
+ p data # => Object
462
+ rescue ScrapeBadger::ApiError => e
463
+ puts "Error when calling RedditApi->reddit_get_subreddit_posts_with_http_info: #{e}"
464
+ end
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+ | Name | Type | Description | Notes |
470
+ | ---- | ---- | ----------- | ----- |
471
+ | **subreddit** | **String** | | |
472
+ | **sort** | **String** | Sort: hot, new, top, rising, controversial | [optional][default to &#39;hot&#39;] |
473
+ | **t** | **String** | Time filter | [optional][default to &#39;all&#39;] |
474
+ | **limit** | **Integer** | | [optional][default to 25] |
475
+ | **after** | **String** | | [optional] |
476
+
477
+ ### Return type
478
+
479
+ **Object**
480
+
481
+ ### Authorization
482
+
483
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: Not defined
488
+ - **Accept**: application/json
489
+
490
+
491
+ ## reddit_get_subreddit_rules
492
+
493
+ > Object reddit_get_subreddit_rules(subreddit)
494
+
495
+ Get subreddit rules
496
+
497
+ Get the rules of a subreddit.
498
+
499
+ ### Examples
500
+
501
+ ```ruby
502
+ require 'time'
503
+ require 'scrapebadger'
504
+ # setup authorization
505
+ ScrapeBadger.configure do |config|
506
+ # Configure API key authorization: ApiKeyAuth
507
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
508
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
509
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
510
+ end
511
+
512
+ api_instance = ScrapeBadger::RedditApi.new
513
+ subreddit = 'subreddit_example' # String |
514
+
515
+ begin
516
+ # Get subreddit rules
517
+ result = api_instance.reddit_get_subreddit_rules(subreddit)
518
+ p result
519
+ rescue ScrapeBadger::ApiError => e
520
+ puts "Error when calling RedditApi->reddit_get_subreddit_rules: #{e}"
521
+ end
522
+ ```
523
+
524
+ #### Using the reddit_get_subreddit_rules_with_http_info variant
525
+
526
+ This returns an Array which contains the response data, status code and headers.
527
+
528
+ > <Array(Object, Integer, Hash)> reddit_get_subreddit_rules_with_http_info(subreddit)
529
+
530
+ ```ruby
531
+ begin
532
+ # Get subreddit rules
533
+ data, status_code, headers = api_instance.reddit_get_subreddit_rules_with_http_info(subreddit)
534
+ p status_code # => 2xx
535
+ p headers # => { ... }
536
+ p data # => Object
537
+ rescue ScrapeBadger::ApiError => e
538
+ puts "Error when calling RedditApi->reddit_get_subreddit_rules_with_http_info: #{e}"
539
+ end
540
+ ```
541
+
542
+ ### Parameters
543
+
544
+ | Name | Type | Description | Notes |
545
+ | ---- | ---- | ----------- | ----- |
546
+ | **subreddit** | **String** | | |
547
+
548
+ ### Return type
549
+
550
+ **Object**
551
+
552
+ ### Authorization
553
+
554
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
555
+
556
+ ### HTTP request headers
557
+
558
+ - **Content-Type**: Not defined
559
+ - **Accept**: application/json
560
+
561
+
562
+ ## reddit_get_trending_posts
563
+
564
+ > Object reddit_get_trending_posts(opts)
565
+
566
+ Get trending posts
567
+
568
+ Get trending posts from Reddit's front page.
569
+
570
+ ### Examples
571
+
572
+ ```ruby
573
+ require 'time'
574
+ require 'scrapebadger'
575
+ # setup authorization
576
+ ScrapeBadger.configure do |config|
577
+ # Configure API key authorization: ApiKeyAuth
578
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
579
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
580
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
581
+ end
582
+
583
+ api_instance = ScrapeBadger::RedditApi.new
584
+ opts = {
585
+ sort: 'sort_example', # String | Sort: hot, new, top, rising, controversial, best
586
+ t: 't_example', # String | Time filter
587
+ limit: 56, # Integer |
588
+ after: 'after_example' # String |
589
+ }
590
+
591
+ begin
592
+ # Get trending posts
593
+ result = api_instance.reddit_get_trending_posts(opts)
594
+ p result
595
+ rescue ScrapeBadger::ApiError => e
596
+ puts "Error when calling RedditApi->reddit_get_trending_posts: #{e}"
597
+ end
598
+ ```
599
+
600
+ #### Using the reddit_get_trending_posts_with_http_info variant
601
+
602
+ This returns an Array which contains the response data, status code and headers.
603
+
604
+ > <Array(Object, Integer, Hash)> reddit_get_trending_posts_with_http_info(opts)
605
+
606
+ ```ruby
607
+ begin
608
+ # Get trending posts
609
+ data, status_code, headers = api_instance.reddit_get_trending_posts_with_http_info(opts)
610
+ p status_code # => 2xx
611
+ p headers # => { ... }
612
+ p data # => Object
613
+ rescue ScrapeBadger::ApiError => e
614
+ puts "Error when calling RedditApi->reddit_get_trending_posts_with_http_info: #{e}"
615
+ end
616
+ ```
617
+
618
+ ### Parameters
619
+
620
+ | Name | Type | Description | Notes |
621
+ | ---- | ---- | ----------- | ----- |
622
+ | **sort** | **String** | Sort: hot, new, top, rising, controversial, best | [optional][default to &#39;hot&#39;] |
623
+ | **t** | **String** | Time filter | [optional][default to &#39;day&#39;] |
624
+ | **limit** | **Integer** | | [optional][default to 25] |
625
+ | **after** | **String** | | [optional] |
626
+
627
+ ### Return type
628
+
629
+ **Object**
630
+
631
+ ### Authorization
632
+
633
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
634
+
635
+ ### HTTP request headers
636
+
637
+ - **Content-Type**: Not defined
638
+ - **Accept**: application/json
639
+
640
+
641
+ ## reddit_get_user_profile
642
+
643
+ > Object reddit_get_user_profile(username)
644
+
645
+ Get user profile
646
+
647
+ Get a Reddit user's profile.
648
+
649
+ ### Examples
650
+
651
+ ```ruby
652
+ require 'time'
653
+ require 'scrapebadger'
654
+ # setup authorization
655
+ ScrapeBadger.configure do |config|
656
+ # Configure API key authorization: ApiKeyAuth
657
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
658
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
659
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
660
+ end
661
+
662
+ api_instance = ScrapeBadger::RedditApi.new
663
+ username = 'username_example' # String |
664
+
665
+ begin
666
+ # Get user profile
667
+ result = api_instance.reddit_get_user_profile(username)
668
+ p result
669
+ rescue ScrapeBadger::ApiError => e
670
+ puts "Error when calling RedditApi->reddit_get_user_profile: #{e}"
671
+ end
672
+ ```
673
+
674
+ #### Using the reddit_get_user_profile_with_http_info variant
675
+
676
+ This returns an Array which contains the response data, status code and headers.
677
+
678
+ > <Array(Object, Integer, Hash)> reddit_get_user_profile_with_http_info(username)
679
+
680
+ ```ruby
681
+ begin
682
+ # Get user profile
683
+ data, status_code, headers = api_instance.reddit_get_user_profile_with_http_info(username)
684
+ p status_code # => 2xx
685
+ p headers # => { ... }
686
+ p data # => Object
687
+ rescue ScrapeBadger::ApiError => e
688
+ puts "Error when calling RedditApi->reddit_get_user_profile_with_http_info: #{e}"
689
+ end
690
+ ```
691
+
692
+ ### Parameters
693
+
694
+ | Name | Type | Description | Notes |
695
+ | ---- | ---- | ----------- | ----- |
696
+ | **username** | **String** | | |
697
+
698
+ ### Return type
699
+
700
+ **Object**
701
+
702
+ ### Authorization
703
+
704
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
705
+
706
+ ### HTTP request headers
707
+
708
+ - **Content-Type**: Not defined
709
+ - **Accept**: application/json
710
+
711
+
712
+ ## reddit_get_user_s_comments
713
+
714
+ > Object reddit_get_user_s_comments(username, opts)
715
+
716
+ Get user's comments
717
+
718
+ Get comments by a Reddit user.
719
+
720
+ ### Examples
721
+
722
+ ```ruby
723
+ require 'time'
724
+ require 'scrapebadger'
725
+ # setup authorization
726
+ ScrapeBadger.configure do |config|
727
+ # Configure API key authorization: ApiKeyAuth
728
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
729
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
730
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
731
+ end
732
+
733
+ api_instance = ScrapeBadger::RedditApi.new
734
+ username = 'username_example' # String |
735
+ opts = {
736
+ sort: 'sort_example', # String |
737
+ t: 't_example', # String |
738
+ limit: 56, # Integer |
739
+ after: 'after_example' # String |
740
+ }
741
+
742
+ begin
743
+ # Get user's comments
744
+ result = api_instance.reddit_get_user_s_comments(username, opts)
745
+ p result
746
+ rescue ScrapeBadger::ApiError => e
747
+ puts "Error when calling RedditApi->reddit_get_user_s_comments: #{e}"
748
+ end
749
+ ```
750
+
751
+ #### Using the reddit_get_user_s_comments_with_http_info variant
752
+
753
+ This returns an Array which contains the response data, status code and headers.
754
+
755
+ > <Array(Object, Integer, Hash)> reddit_get_user_s_comments_with_http_info(username, opts)
756
+
757
+ ```ruby
758
+ begin
759
+ # Get user's comments
760
+ data, status_code, headers = api_instance.reddit_get_user_s_comments_with_http_info(username, opts)
761
+ p status_code # => 2xx
762
+ p headers # => { ... }
763
+ p data # => Object
764
+ rescue ScrapeBadger::ApiError => e
765
+ puts "Error when calling RedditApi->reddit_get_user_s_comments_with_http_info: #{e}"
766
+ end
767
+ ```
768
+
769
+ ### Parameters
770
+
771
+ | Name | Type | Description | Notes |
772
+ | ---- | ---- | ----------- | ----- |
773
+ | **username** | **String** | | |
774
+ | **sort** | **String** | | [optional][default to &#39;new&#39;] |
775
+ | **t** | **String** | | [optional][default to &#39;all&#39;] |
776
+ | **limit** | **Integer** | | [optional][default to 25] |
777
+ | **after** | **String** | | [optional] |
778
+
779
+ ### Return type
780
+
781
+ **Object**
782
+
783
+ ### Authorization
784
+
785
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
786
+
787
+ ### HTTP request headers
788
+
789
+ - **Content-Type**: Not defined
790
+ - **Accept**: application/json
791
+
792
+
793
+ ## reddit_get_user_s_moderated_subreddits
794
+
795
+ > Object reddit_get_user_s_moderated_subreddits(username)
796
+
797
+ Get user's moderated subreddits
798
+
799
+ Get subreddits moderated by a user.
800
+
801
+ ### Examples
802
+
803
+ ```ruby
804
+ require 'time'
805
+ require 'scrapebadger'
806
+ # setup authorization
807
+ ScrapeBadger.configure do |config|
808
+ # Configure API key authorization: ApiKeyAuth
809
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
810
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
811
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
812
+ end
813
+
814
+ api_instance = ScrapeBadger::RedditApi.new
815
+ username = 'username_example' # String |
816
+
817
+ begin
818
+ # Get user's moderated subreddits
819
+ result = api_instance.reddit_get_user_s_moderated_subreddits(username)
820
+ p result
821
+ rescue ScrapeBadger::ApiError => e
822
+ puts "Error when calling RedditApi->reddit_get_user_s_moderated_subreddits: #{e}"
823
+ end
824
+ ```
825
+
826
+ #### Using the reddit_get_user_s_moderated_subreddits_with_http_info variant
827
+
828
+ This returns an Array which contains the response data, status code and headers.
829
+
830
+ > <Array(Object, Integer, Hash)> reddit_get_user_s_moderated_subreddits_with_http_info(username)
831
+
832
+ ```ruby
833
+ begin
834
+ # Get user's moderated subreddits
835
+ data, status_code, headers = api_instance.reddit_get_user_s_moderated_subreddits_with_http_info(username)
836
+ p status_code # => 2xx
837
+ p headers # => { ... }
838
+ p data # => Object
839
+ rescue ScrapeBadger::ApiError => e
840
+ puts "Error when calling RedditApi->reddit_get_user_s_moderated_subreddits_with_http_info: #{e}"
841
+ end
842
+ ```
843
+
844
+ ### Parameters
845
+
846
+ | Name | Type | Description | Notes |
847
+ | ---- | ---- | ----------- | ----- |
848
+ | **username** | **String** | | |
849
+
850
+ ### Return type
851
+
852
+ **Object**
853
+
854
+ ### Authorization
855
+
856
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
857
+
858
+ ### HTTP request headers
859
+
860
+ - **Content-Type**: Not defined
861
+ - **Accept**: application/json
862
+
863
+
864
+ ## reddit_get_user_s_posts
865
+
866
+ > Object reddit_get_user_s_posts(username, opts)
867
+
868
+ Get user's posts
869
+
870
+ Get posts submitted by a Reddit user.
871
+
872
+ ### Examples
873
+
874
+ ```ruby
875
+ require 'time'
876
+ require 'scrapebadger'
877
+ # setup authorization
878
+ ScrapeBadger.configure do |config|
879
+ # Configure API key authorization: ApiKeyAuth
880
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
881
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
882
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
883
+ end
884
+
885
+ api_instance = ScrapeBadger::RedditApi.new
886
+ username = 'username_example' # String |
887
+ opts = {
888
+ sort: 'sort_example', # String |
889
+ t: 't_example', # String |
890
+ limit: 56, # Integer |
891
+ after: 'after_example' # String |
892
+ }
893
+
894
+ begin
895
+ # Get user's posts
896
+ result = api_instance.reddit_get_user_s_posts(username, opts)
897
+ p result
898
+ rescue ScrapeBadger::ApiError => e
899
+ puts "Error when calling RedditApi->reddit_get_user_s_posts: #{e}"
900
+ end
901
+ ```
902
+
903
+ #### Using the reddit_get_user_s_posts_with_http_info variant
904
+
905
+ This returns an Array which contains the response data, status code and headers.
906
+
907
+ > <Array(Object, Integer, Hash)> reddit_get_user_s_posts_with_http_info(username, opts)
908
+
909
+ ```ruby
910
+ begin
911
+ # Get user's posts
912
+ data, status_code, headers = api_instance.reddit_get_user_s_posts_with_http_info(username, opts)
913
+ p status_code # => 2xx
914
+ p headers # => { ... }
915
+ p data # => Object
916
+ rescue ScrapeBadger::ApiError => e
917
+ puts "Error when calling RedditApi->reddit_get_user_s_posts_with_http_info: #{e}"
918
+ end
919
+ ```
920
+
921
+ ### Parameters
922
+
923
+ | Name | Type | Description | Notes |
924
+ | ---- | ---- | ----------- | ----- |
925
+ | **username** | **String** | | |
926
+ | **sort** | **String** | | [optional][default to &#39;new&#39;] |
927
+ | **t** | **String** | | [optional][default to &#39;all&#39;] |
928
+ | **limit** | **Integer** | | [optional][default to 25] |
929
+ | **after** | **String** | | [optional] |
930
+
931
+ ### Return type
932
+
933
+ **Object**
934
+
935
+ ### Authorization
936
+
937
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
938
+
939
+ ### HTTP request headers
940
+
941
+ - **Content-Type**: Not defined
942
+ - **Accept**: application/json
943
+
944
+
945
+ ## reddit_get_user_s_trophies
946
+
947
+ > Object reddit_get_user_s_trophies(username)
948
+
949
+ Get user's trophies
950
+
951
+ Get a user's trophy case.
952
+
953
+ ### Examples
954
+
955
+ ```ruby
956
+ require 'time'
957
+ require 'scrapebadger'
958
+ # setup authorization
959
+ ScrapeBadger.configure do |config|
960
+ # Configure API key authorization: ApiKeyAuth
961
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
962
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
963
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
964
+ end
965
+
966
+ api_instance = ScrapeBadger::RedditApi.new
967
+ username = 'username_example' # String |
968
+
969
+ begin
970
+ # Get user's trophies
971
+ result = api_instance.reddit_get_user_s_trophies(username)
972
+ p result
973
+ rescue ScrapeBadger::ApiError => e
974
+ puts "Error when calling RedditApi->reddit_get_user_s_trophies: #{e}"
975
+ end
976
+ ```
977
+
978
+ #### Using the reddit_get_user_s_trophies_with_http_info variant
979
+
980
+ This returns an Array which contains the response data, status code and headers.
981
+
982
+ > <Array(Object, Integer, Hash)> reddit_get_user_s_trophies_with_http_info(username)
983
+
984
+ ```ruby
985
+ begin
986
+ # Get user's trophies
987
+ data, status_code, headers = api_instance.reddit_get_user_s_trophies_with_http_info(username)
988
+ p status_code # => 2xx
989
+ p headers # => { ... }
990
+ p data # => Object
991
+ rescue ScrapeBadger::ApiError => e
992
+ puts "Error when calling RedditApi->reddit_get_user_s_trophies_with_http_info: #{e}"
993
+ end
994
+ ```
995
+
996
+ ### Parameters
997
+
998
+ | Name | Type | Description | Notes |
999
+ | ---- | ---- | ----------- | ----- |
1000
+ | **username** | **String** | | |
1001
+
1002
+ ### Return type
1003
+
1004
+ **Object**
1005
+
1006
+ ### Authorization
1007
+
1008
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1009
+
1010
+ ### HTTP request headers
1011
+
1012
+ - **Content-Type**: Not defined
1013
+ - **Accept**: application/json
1014
+
1015
+
1016
+ ## reddit_get_wiki_page_content
1017
+
1018
+ > Object reddit_get_wiki_page_content(subreddit, page)
1019
+
1020
+ Get wiki page content
1021
+
1022
+ Get the content of a specific wiki page.
1023
+
1024
+ ### Examples
1025
+
1026
+ ```ruby
1027
+ require 'time'
1028
+ require 'scrapebadger'
1029
+ # setup authorization
1030
+ ScrapeBadger.configure do |config|
1031
+ # Configure API key authorization: ApiKeyAuth
1032
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1033
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1034
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1035
+ end
1036
+
1037
+ api_instance = ScrapeBadger::RedditApi.new
1038
+ subreddit = 'subreddit_example' # String |
1039
+ page = 'page_example' # String |
1040
+
1041
+ begin
1042
+ # Get wiki page content
1043
+ result = api_instance.reddit_get_wiki_page_content(subreddit, page)
1044
+ p result
1045
+ rescue ScrapeBadger::ApiError => e
1046
+ puts "Error when calling RedditApi->reddit_get_wiki_page_content: #{e}"
1047
+ end
1048
+ ```
1049
+
1050
+ #### Using the reddit_get_wiki_page_content_with_http_info variant
1051
+
1052
+ This returns an Array which contains the response data, status code and headers.
1053
+
1054
+ > <Array(Object, Integer, Hash)> reddit_get_wiki_page_content_with_http_info(subreddit, page)
1055
+
1056
+ ```ruby
1057
+ begin
1058
+ # Get wiki page content
1059
+ data, status_code, headers = api_instance.reddit_get_wiki_page_content_with_http_info(subreddit, page)
1060
+ p status_code # => 2xx
1061
+ p headers # => { ... }
1062
+ p data # => Object
1063
+ rescue ScrapeBadger::ApiError => e
1064
+ puts "Error when calling RedditApi->reddit_get_wiki_page_content_with_http_info: #{e}"
1065
+ end
1066
+ ```
1067
+
1068
+ ### Parameters
1069
+
1070
+ | Name | Type | Description | Notes |
1071
+ | ---- | ---- | ----------- | ----- |
1072
+ | **subreddit** | **String** | | |
1073
+ | **page** | **String** | | |
1074
+
1075
+ ### Return type
1076
+
1077
+ **Object**
1078
+
1079
+ ### Authorization
1080
+
1081
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1082
+
1083
+ ### HTTP request headers
1084
+
1085
+ - **Content-Type**: Not defined
1086
+ - **Accept**: application/json
1087
+
1088
+
1089
+ ## reddit_list_wiki_pages
1090
+
1091
+ > Object reddit_list_wiki_pages(subreddit)
1092
+
1093
+ List wiki pages
1094
+
1095
+ List all wiki pages in a subreddit.
1096
+
1097
+ ### Examples
1098
+
1099
+ ```ruby
1100
+ require 'time'
1101
+ require 'scrapebadger'
1102
+ # setup authorization
1103
+ ScrapeBadger.configure do |config|
1104
+ # Configure API key authorization: ApiKeyAuth
1105
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1107
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1108
+ end
1109
+
1110
+ api_instance = ScrapeBadger::RedditApi.new
1111
+ subreddit = 'subreddit_example' # String |
1112
+
1113
+ begin
1114
+ # List wiki pages
1115
+ result = api_instance.reddit_list_wiki_pages(subreddit)
1116
+ p result
1117
+ rescue ScrapeBadger::ApiError => e
1118
+ puts "Error when calling RedditApi->reddit_list_wiki_pages: #{e}"
1119
+ end
1120
+ ```
1121
+
1122
+ #### Using the reddit_list_wiki_pages_with_http_info variant
1123
+
1124
+ This returns an Array which contains the response data, status code and headers.
1125
+
1126
+ > <Array(Object, Integer, Hash)> reddit_list_wiki_pages_with_http_info(subreddit)
1127
+
1128
+ ```ruby
1129
+ begin
1130
+ # List wiki pages
1131
+ data, status_code, headers = api_instance.reddit_list_wiki_pages_with_http_info(subreddit)
1132
+ p status_code # => 2xx
1133
+ p headers # => { ... }
1134
+ p data # => Object
1135
+ rescue ScrapeBadger::ApiError => e
1136
+ puts "Error when calling RedditApi->reddit_list_wiki_pages_with_http_info: #{e}"
1137
+ end
1138
+ ```
1139
+
1140
+ ### Parameters
1141
+
1142
+ | Name | Type | Description | Notes |
1143
+ | ---- | ---- | ----------- | ----- |
1144
+ | **subreddit** | **String** | | |
1145
+
1146
+ ### Return type
1147
+
1148
+ **Object**
1149
+
1150
+ ### Authorization
1151
+
1152
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1153
+
1154
+ ### HTTP request headers
1155
+
1156
+ - **Content-Type**: Not defined
1157
+ - **Accept**: application/json
1158
+
1159
+
1160
+ ## reddit_new_subreddits
1161
+
1162
+ > Object reddit_new_subreddits(opts)
1163
+
1164
+ New subreddits
1165
+
1166
+ Get recently created subreddits.
1167
+
1168
+ ### Examples
1169
+
1170
+ ```ruby
1171
+ require 'time'
1172
+ require 'scrapebadger'
1173
+ # setup authorization
1174
+ ScrapeBadger.configure do |config|
1175
+ # Configure API key authorization: ApiKeyAuth
1176
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1177
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1178
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1179
+ end
1180
+
1181
+ api_instance = ScrapeBadger::RedditApi.new
1182
+ opts = {
1183
+ limit: 56, # Integer |
1184
+ after: 'after_example' # String |
1185
+ }
1186
+
1187
+ begin
1188
+ # New subreddits
1189
+ result = api_instance.reddit_new_subreddits(opts)
1190
+ p result
1191
+ rescue ScrapeBadger::ApiError => e
1192
+ puts "Error when calling RedditApi->reddit_new_subreddits: #{e}"
1193
+ end
1194
+ ```
1195
+
1196
+ #### Using the reddit_new_subreddits_with_http_info variant
1197
+
1198
+ This returns an Array which contains the response data, status code and headers.
1199
+
1200
+ > <Array(Object, Integer, Hash)> reddit_new_subreddits_with_http_info(opts)
1201
+
1202
+ ```ruby
1203
+ begin
1204
+ # New subreddits
1205
+ data, status_code, headers = api_instance.reddit_new_subreddits_with_http_info(opts)
1206
+ p status_code # => 2xx
1207
+ p headers # => { ... }
1208
+ p data # => Object
1209
+ rescue ScrapeBadger::ApiError => e
1210
+ puts "Error when calling RedditApi->reddit_new_subreddits_with_http_info: #{e}"
1211
+ end
1212
+ ```
1213
+
1214
+ ### Parameters
1215
+
1216
+ | Name | Type | Description | Notes |
1217
+ | ---- | ---- | ----------- | ----- |
1218
+ | **limit** | **Integer** | | [optional][default to 25] |
1219
+ | **after** | **String** | | [optional] |
1220
+
1221
+ ### Return type
1222
+
1223
+ **Object**
1224
+
1225
+ ### Authorization
1226
+
1227
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1228
+
1229
+ ### HTTP request headers
1230
+
1231
+ - **Content-Type**: Not defined
1232
+ - **Accept**: application/json
1233
+
1234
+
1235
+ ## reddit_popular_subreddits
1236
+
1237
+ > Object reddit_popular_subreddits(opts)
1238
+
1239
+ Popular subreddits
1240
+
1241
+ Get popular subreddits by subscriber count.
1242
+
1243
+ ### Examples
1244
+
1245
+ ```ruby
1246
+ require 'time'
1247
+ require 'scrapebadger'
1248
+ # setup authorization
1249
+ ScrapeBadger.configure do |config|
1250
+ # Configure API key authorization: ApiKeyAuth
1251
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1252
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1253
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1254
+ end
1255
+
1256
+ api_instance = ScrapeBadger::RedditApi.new
1257
+ opts = {
1258
+ limit: 56, # Integer |
1259
+ after: 'after_example' # String |
1260
+ }
1261
+
1262
+ begin
1263
+ # Popular subreddits
1264
+ result = api_instance.reddit_popular_subreddits(opts)
1265
+ p result
1266
+ rescue ScrapeBadger::ApiError => e
1267
+ puts "Error when calling RedditApi->reddit_popular_subreddits: #{e}"
1268
+ end
1269
+ ```
1270
+
1271
+ #### Using the reddit_popular_subreddits_with_http_info variant
1272
+
1273
+ This returns an Array which contains the response data, status code and headers.
1274
+
1275
+ > <Array(Object, Integer, Hash)> reddit_popular_subreddits_with_http_info(opts)
1276
+
1277
+ ```ruby
1278
+ begin
1279
+ # Popular subreddits
1280
+ data, status_code, headers = api_instance.reddit_popular_subreddits_with_http_info(opts)
1281
+ p status_code # => 2xx
1282
+ p headers # => { ... }
1283
+ p data # => Object
1284
+ rescue ScrapeBadger::ApiError => e
1285
+ puts "Error when calling RedditApi->reddit_popular_subreddits_with_http_info: #{e}"
1286
+ end
1287
+ ```
1288
+
1289
+ ### Parameters
1290
+
1291
+ | Name | Type | Description | Notes |
1292
+ | ---- | ---- | ----------- | ----- |
1293
+ | **limit** | **Integer** | | [optional][default to 25] |
1294
+ | **after** | **String** | | [optional] |
1295
+
1296
+ ### Return type
1297
+
1298
+ **Object**
1299
+
1300
+ ### Authorization
1301
+
1302
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1303
+
1304
+ ### HTTP request headers
1305
+
1306
+ - **Content-Type**: Not defined
1307
+ - **Accept**: application/json
1308
+
1309
+
1310
+ ## reddit_reddit_scraper_health_check
1311
+
1312
+ > Object reddit_reddit_scraper_health_check
1313
+
1314
+ Reddit scraper health check
1315
+
1316
+ ### Examples
1317
+
1318
+ ```ruby
1319
+ require 'time'
1320
+ require 'scrapebadger'
1321
+ # setup authorization
1322
+ ScrapeBadger.configure do |config|
1323
+ # Configure API key authorization: ApiKeyAuth
1324
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1325
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1326
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1327
+ end
1328
+
1329
+ api_instance = ScrapeBadger::RedditApi.new
1330
+
1331
+ begin
1332
+ # Reddit scraper health check
1333
+ result = api_instance.reddit_reddit_scraper_health_check
1334
+ p result
1335
+ rescue ScrapeBadger::ApiError => e
1336
+ puts "Error when calling RedditApi->reddit_reddit_scraper_health_check: #{e}"
1337
+ end
1338
+ ```
1339
+
1340
+ #### Using the reddit_reddit_scraper_health_check_with_http_info variant
1341
+
1342
+ This returns an Array which contains the response data, status code and headers.
1343
+
1344
+ > <Array(Object, Integer, Hash)> reddit_reddit_scraper_health_check_with_http_info
1345
+
1346
+ ```ruby
1347
+ begin
1348
+ # Reddit scraper health check
1349
+ data, status_code, headers = api_instance.reddit_reddit_scraper_health_check_with_http_info
1350
+ p status_code # => 2xx
1351
+ p headers # => { ... }
1352
+ p data # => Object
1353
+ rescue ScrapeBadger::ApiError => e
1354
+ puts "Error when calling RedditApi->reddit_reddit_scraper_health_check_with_http_info: #{e}"
1355
+ end
1356
+ ```
1357
+
1358
+ ### Parameters
1359
+
1360
+ This endpoint does not need any parameter.
1361
+
1362
+ ### Return type
1363
+
1364
+ **Object**
1365
+
1366
+ ### Authorization
1367
+
1368
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1369
+
1370
+ ### HTTP request headers
1371
+
1372
+ - **Content-Type**: Not defined
1373
+ - **Accept**: application/json
1374
+
1375
+
1376
+ ## reddit_reddit_scraper_health_check_head
1377
+
1378
+ > Object reddit_reddit_scraper_health_check_head
1379
+
1380
+ Reddit scraper health check
1381
+
1382
+ ### Examples
1383
+
1384
+ ```ruby
1385
+ require 'time'
1386
+ require 'scrapebadger'
1387
+ # setup authorization
1388
+ ScrapeBadger.configure do |config|
1389
+ # Configure API key authorization: ApiKeyAuth
1390
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1392
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1393
+ end
1394
+
1395
+ api_instance = ScrapeBadger::RedditApi.new
1396
+
1397
+ begin
1398
+ # Reddit scraper health check
1399
+ result = api_instance.reddit_reddit_scraper_health_check_head
1400
+ p result
1401
+ rescue ScrapeBadger::ApiError => e
1402
+ puts "Error when calling RedditApi->reddit_reddit_scraper_health_check_head: #{e}"
1403
+ end
1404
+ ```
1405
+
1406
+ #### Using the reddit_reddit_scraper_health_check_head_with_http_info variant
1407
+
1408
+ This returns an Array which contains the response data, status code and headers.
1409
+
1410
+ > <Array(Object, Integer, Hash)> reddit_reddit_scraper_health_check_head_with_http_info
1411
+
1412
+ ```ruby
1413
+ begin
1414
+ # Reddit scraper health check
1415
+ data, status_code, headers = api_instance.reddit_reddit_scraper_health_check_head_with_http_info
1416
+ p status_code # => 2xx
1417
+ p headers # => { ... }
1418
+ p data # => Object
1419
+ rescue ScrapeBadger::ApiError => e
1420
+ puts "Error when calling RedditApi->reddit_reddit_scraper_health_check_head_with_http_info: #{e}"
1421
+ end
1422
+ ```
1423
+
1424
+ ### Parameters
1425
+
1426
+ This endpoint does not need any parameter.
1427
+
1428
+ ### Return type
1429
+
1430
+ **Object**
1431
+
1432
+ ### Authorization
1433
+
1434
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1435
+
1436
+ ### HTTP request headers
1437
+
1438
+ - **Content-Type**: Not defined
1439
+ - **Accept**: application/json
1440
+
1441
+
1442
+ ## reddit_search_reddit_posts
1443
+
1444
+ > Object reddit_search_reddit_posts(q, opts)
1445
+
1446
+ Search Reddit posts
1447
+
1448
+ Search Reddit posts globally or within a subreddit.
1449
+
1450
+ ### Examples
1451
+
1452
+ ```ruby
1453
+ require 'time'
1454
+ require 'scrapebadger'
1455
+ # setup authorization
1456
+ ScrapeBadger.configure do |config|
1457
+ # Configure API key authorization: ApiKeyAuth
1458
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1459
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1460
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1461
+ end
1462
+
1463
+ api_instance = ScrapeBadger::RedditApi.new
1464
+ q = 'q_example' # String | Search query
1465
+ opts = {
1466
+ subreddit: 'subreddit_example', # String | Restrict to subreddit
1467
+ sort: 'sort_example', # String | Sort: relevance, hot, top, new, comments
1468
+ t: 't_example', # String | Time: hour, day, week, month, year, all
1469
+ limit: 56, # Integer |
1470
+ after: 'after_example' # String |
1471
+ }
1472
+
1473
+ begin
1474
+ # Search Reddit posts
1475
+ result = api_instance.reddit_search_reddit_posts(q, opts)
1476
+ p result
1477
+ rescue ScrapeBadger::ApiError => e
1478
+ puts "Error when calling RedditApi->reddit_search_reddit_posts: #{e}"
1479
+ end
1480
+ ```
1481
+
1482
+ #### Using the reddit_search_reddit_posts_with_http_info variant
1483
+
1484
+ This returns an Array which contains the response data, status code and headers.
1485
+
1486
+ > <Array(Object, Integer, Hash)> reddit_search_reddit_posts_with_http_info(q, opts)
1487
+
1488
+ ```ruby
1489
+ begin
1490
+ # Search Reddit posts
1491
+ data, status_code, headers = api_instance.reddit_search_reddit_posts_with_http_info(q, opts)
1492
+ p status_code # => 2xx
1493
+ p headers # => { ... }
1494
+ p data # => Object
1495
+ rescue ScrapeBadger::ApiError => e
1496
+ puts "Error when calling RedditApi->reddit_search_reddit_posts_with_http_info: #{e}"
1497
+ end
1498
+ ```
1499
+
1500
+ ### Parameters
1501
+
1502
+ | Name | Type | Description | Notes |
1503
+ | ---- | ---- | ----------- | ----- |
1504
+ | **q** | **String** | Search query | |
1505
+ | **subreddit** | **String** | Restrict to subreddit | [optional] |
1506
+ | **sort** | **String** | Sort: relevance, hot, top, new, comments | [optional][default to &#39;relevance&#39;] |
1507
+ | **t** | **String** | Time: hour, day, week, month, year, all | [optional][default to &#39;all&#39;] |
1508
+ | **limit** | **Integer** | | [optional][default to 25] |
1509
+ | **after** | **String** | | [optional] |
1510
+
1511
+ ### Return type
1512
+
1513
+ **Object**
1514
+
1515
+ ### Authorization
1516
+
1517
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1518
+
1519
+ ### HTTP request headers
1520
+
1521
+ - **Content-Type**: Not defined
1522
+ - **Accept**: application/json
1523
+
1524
+
1525
+ ## reddit_search_subreddits
1526
+
1527
+ > Object reddit_search_subreddits(q, opts)
1528
+
1529
+ Search subreddits
1530
+
1531
+ Search for subreddits by keyword.
1532
+
1533
+ ### Examples
1534
+
1535
+ ```ruby
1536
+ require 'time'
1537
+ require 'scrapebadger'
1538
+ # setup authorization
1539
+ ScrapeBadger.configure do |config|
1540
+ # Configure API key authorization: ApiKeyAuth
1541
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1542
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1543
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1544
+ end
1545
+
1546
+ api_instance = ScrapeBadger::RedditApi.new
1547
+ q = 'q_example' # String | Search query
1548
+ opts = {
1549
+ limit: 56, # Integer |
1550
+ after: 'after_example' # String |
1551
+ }
1552
+
1553
+ begin
1554
+ # Search subreddits
1555
+ result = api_instance.reddit_search_subreddits(q, opts)
1556
+ p result
1557
+ rescue ScrapeBadger::ApiError => e
1558
+ puts "Error when calling RedditApi->reddit_search_subreddits: #{e}"
1559
+ end
1560
+ ```
1561
+
1562
+ #### Using the reddit_search_subreddits_with_http_info variant
1563
+
1564
+ This returns an Array which contains the response data, status code and headers.
1565
+
1566
+ > <Array(Object, Integer, Hash)> reddit_search_subreddits_with_http_info(q, opts)
1567
+
1568
+ ```ruby
1569
+ begin
1570
+ # Search subreddits
1571
+ data, status_code, headers = api_instance.reddit_search_subreddits_with_http_info(q, opts)
1572
+ p status_code # => 2xx
1573
+ p headers # => { ... }
1574
+ p data # => Object
1575
+ rescue ScrapeBadger::ApiError => e
1576
+ puts "Error when calling RedditApi->reddit_search_subreddits_with_http_info: #{e}"
1577
+ end
1578
+ ```
1579
+
1580
+ ### Parameters
1581
+
1582
+ | Name | Type | Description | Notes |
1583
+ | ---- | ---- | ----------- | ----- |
1584
+ | **q** | **String** | Search query | |
1585
+ | **limit** | **Integer** | | [optional][default to 25] |
1586
+ | **after** | **String** | | [optional] |
1587
+
1588
+ ### Return type
1589
+
1590
+ **Object**
1591
+
1592
+ ### Authorization
1593
+
1594
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1595
+
1596
+ ### HTTP request headers
1597
+
1598
+ - **Content-Type**: Not defined
1599
+ - **Accept**: application/json
1600
+
1601
+
1602
+ ## reddit_search_users
1603
+
1604
+ > Object reddit_search_users(q, opts)
1605
+
1606
+ Search users
1607
+
1608
+ Search for Reddit users.
1609
+
1610
+ ### Examples
1611
+
1612
+ ```ruby
1613
+ require 'time'
1614
+ require 'scrapebadger'
1615
+ # setup authorization
1616
+ ScrapeBadger.configure do |config|
1617
+ # Configure API key authorization: ApiKeyAuth
1618
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1619
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1620
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1621
+ end
1622
+
1623
+ api_instance = ScrapeBadger::RedditApi.new
1624
+ q = 'q_example' # String | Search query
1625
+ opts = {
1626
+ limit: 56, # Integer |
1627
+ after: 'after_example' # String |
1628
+ }
1629
+
1630
+ begin
1631
+ # Search users
1632
+ result = api_instance.reddit_search_users(q, opts)
1633
+ p result
1634
+ rescue ScrapeBadger::ApiError => e
1635
+ puts "Error when calling RedditApi->reddit_search_users: #{e}"
1636
+ end
1637
+ ```
1638
+
1639
+ #### Using the reddit_search_users_with_http_info variant
1640
+
1641
+ This returns an Array which contains the response data, status code and headers.
1642
+
1643
+ > <Array(Object, Integer, Hash)> reddit_search_users_with_http_info(q, opts)
1644
+
1645
+ ```ruby
1646
+ begin
1647
+ # Search users
1648
+ data, status_code, headers = api_instance.reddit_search_users_with_http_info(q, opts)
1649
+ p status_code # => 2xx
1650
+ p headers # => { ... }
1651
+ p data # => Object
1652
+ rescue ScrapeBadger::ApiError => e
1653
+ puts "Error when calling RedditApi->reddit_search_users_with_http_info: #{e}"
1654
+ end
1655
+ ```
1656
+
1657
+ ### Parameters
1658
+
1659
+ | Name | Type | Description | Notes |
1660
+ | ---- | ---- | ----------- | ----- |
1661
+ | **q** | **String** | Search query | |
1662
+ | **limit** | **Integer** | | [optional][default to 25] |
1663
+ | **after** | **String** | | [optional] |
1664
+
1665
+ ### Return type
1666
+
1667
+ **Object**
1668
+
1669
+ ### Authorization
1670
+
1671
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1672
+
1673
+ ### HTTP request headers
1674
+
1675
+ - **Content-Type**: Not defined
1676
+ - **Accept**: application/json
1677
+