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