finnhub_ruby 1.1.12 → 1.1.15

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -2
  3. data/docs/BondCandles.md +22 -0
  4. data/docs/BondProfile.md +58 -0
  5. data/docs/DefaultApi.md +393 -7
  6. data/docs/InsiderSentiments.md +20 -0
  7. data/docs/InsiderSentimentsData.md +26 -0
  8. data/docs/LobbyingData.md +46 -0
  9. data/docs/LobbyingResult.md +20 -0
  10. data/docs/UsptoPatent.md +1 -1
  11. data/docs/VisaApplication.md +62 -0
  12. data/docs/VisaApplicationResult.md +20 -0
  13. data/finnhub_ruby-1.1.12.gem +0 -0
  14. data/finnhub_ruby-1.1.13.gem +0 -0
  15. data/finnhub_ruby-1.1.14.gem +0 -0
  16. data/lib/finnhub_ruby/api/default_api.rb +394 -10
  17. data/lib/finnhub_ruby/models/bond_candles.rb +243 -0
  18. data/lib/finnhub_ruby/models/bond_profile.rb +419 -0
  19. data/lib/finnhub_ruby/models/insider_sentiments.rb +231 -0
  20. data/lib/finnhub_ruby/models/insider_sentiments_data.rb +259 -0
  21. data/lib/finnhub_ruby/models/lobbying_data.rb +359 -0
  22. data/lib/finnhub_ruby/models/lobbying_result.rb +231 -0
  23. data/lib/finnhub_ruby/models/uspto_patent.rb +1 -1
  24. data/lib/finnhub_ruby/models/visa_application.rb +439 -0
  25. data/lib/finnhub_ruby/models/visa_application_result.rb +231 -0
  26. data/lib/finnhub_ruby/version.rb +1 -1
  27. data/lib/finnhub_ruby.rb +8 -0
  28. data/spec/models/bond_candles_spec.rb +46 -0
  29. data/spec/models/bond_profile_spec.rb +154 -0
  30. data/spec/models/insider_sentiments_data_spec.rb +58 -0
  31. data/spec/models/insider_sentiments_spec.rb +40 -0
  32. data/spec/models/lobbying_data_spec.rb +118 -0
  33. data/spec/models/lobbying_result_spec.rb +40 -0
  34. data/spec/models/visa_application_result_spec.rb +40 -0
  35. data/spec/models/visa_application_spec.rb +166 -0
  36. metadata +37 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 673dff85fca4569468c9266af247714554296a6417f18caa8fb652de5cd35ca3
4
- data.tar.gz: '06890889ff4f66e2c4675ff20b7d9912dcaccff1172d28b6093c47e2f1e892df'
3
+ metadata.gz: 1eb9be10d64f2d31e2bc650ead53d2cf0171ab2a5745def2db38f07d77762176
4
+ data.tar.gz: 77a1b37f54aea5c20055e0d3a4df528bfd5e26620aa197c37c3f14d1843fa4a6
5
5
  SHA512:
6
- metadata.gz: d30aefb33b9d6fc51c68fa17cea7fb700da02491e1280491f847664d8b337365168eac933cf27725cb4488094a08e0d68d4bbf454dfe1d43f6740e8e42acc563
7
- data.tar.gz: b2f491a4a784874ef91512b8384ac1d855ff03780a4ffad62e045aa23fd69229a3157cadb1ebe8df093ce94fe7c3eeac5fbd8a13ef9c0dba90a86b1f1bcdad90
6
+ metadata.gz: 0430e5f97277f8449e84b4c74e5e5809b4a566ee5a51654b18e580ed5020a6f2ed1365f613100b083800b26e4e57b337e5843ace61cad8120866c0590b36bb3b
7
+ data.tar.gz: c578d69cef0a0c8559502a8404e0698dff090fdf37cc4b480d1eaffa714b7565bee6ebfb1728a674debd8a2f6b70808c8cb24d3ae150089dcf834ab8a4addbee
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # finnhub-ruby
2
2
  - API documentation: https://finnhub.io/docs/api
3
3
  - API version: 1.0.0
4
- - Package version: 1.1.12
4
+ - Package version: 1.1.15
5
5
 
6
6
  ## Installation
7
7
  https://rubygems.org/gems/finnhub_ruby
@@ -13,7 +13,7 @@ gem install finnhub_ruby
13
13
  or in your Gemfile
14
14
 
15
15
  ```ruby
16
- gem 'finnhub_ruby', '~> 1.1.12'
16
+ gem 'finnhub_ruby', '~> 1.1.15'
17
17
  ```
18
18
 
19
19
  ## Getting Started
@@ -254,6 +254,9 @@ puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
254
254
  # USPTO
255
255
  puts(finnhub_client.stock_uspto_patent('NVDA', "2020-06-01", "2021-06-10"))
256
256
 
257
+ # Visa Application
258
+ puts(finnhub_client.stock_visa_application('AAPL', "2020-06-01", "2021-06-10"))
259
+
257
260
  ```
258
261
 
259
262
  ## License
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::BondCandles
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **c** | **Array<Float>** | List of close prices for returned candles. | [optional] |
8
+ | **t** | **Array<Integer>** | List of timestamp for returned candles. | [optional] |
9
+ | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::BondCandles.new(
17
+ c: null,
18
+ t: null,
19
+ s: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,58 @@
1
+ # FinnhubRuby::BondProfile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **isin** | **String** | ISIN. | [optional] |
8
+ | **cusip** | **String** | Cusip. | [optional] |
9
+ | **figi** | **String** | FIGI. | [optional] |
10
+ | **coupon** | **Float** | Coupon. | [optional] |
11
+ | **maturity_date** | **String** | Period. | [optional] |
12
+ | **offering_price** | **Float** | Offering price. | [optional] |
13
+ | **issue_date** | **String** | Issue date. | [optional] |
14
+ | **bond_type** | **String** | Bond type. | [optional] |
15
+ | **debt_type** | **String** | Bond type. | [optional] |
16
+ | **industry_group** | **String** | Industry. | [optional] |
17
+ | **industry_sub_group** | **String** | Sub-Industry. | [optional] |
18
+ | **asset** | **String** | Asset. | [optional] |
19
+ | **asset_type** | **String** | Asset. | [optional] |
20
+ | **dated_date** | **String** | Dated date. | [optional] |
21
+ | **first_coupon_date** | **String** | First coupon date. | [optional] |
22
+ | **original_offering** | **Float** | Offering amount. | [optional] |
23
+ | **amount_outstanding** | **Float** | Outstanding amount. | [optional] |
24
+ | **payment_frequency** | **String** | Payment frequency. | [optional] |
25
+ | **security_level** | **String** | Security level. | [optional] |
26
+ | **callable** | **Boolean** | Callable. | [optional] |
27
+ | **coupon_type** | **String** | Coupon type. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'finnhub_ruby'
33
+
34
+ instance = FinnhubRuby::BondProfile.new(
35
+ isin: null,
36
+ cusip: null,
37
+ figi: null,
38
+ coupon: null,
39
+ maturity_date: null,
40
+ offering_price: null,
41
+ issue_date: null,
42
+ bond_type: null,
43
+ debt_type: null,
44
+ industry_group: null,
45
+ industry_sub_group: null,
46
+ asset: null,
47
+ asset_type: null,
48
+ dated_date: null,
49
+ first_coupon_date: null,
50
+ original_offering: null,
51
+ amount_outstanding: null,
52
+ payment_frequency: null,
53
+ security_level: null,
54
+ callable: null,
55
+ coupon_type: null
56
+ )
57
+ ```
58
+
data/docs/DefaultApi.md CHANGED
@@ -5,6 +5,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
8
+ | [**bond_price**](DefaultApi.md#bond_price) | **GET** /bond/price | Bond price data |
9
+ | [**bond_profile**](DefaultApi.md#bond_profile) | **GET** /bond/profile | Bond Profile |
8
10
  | [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
9
11
  | [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
10
12
  | [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
@@ -44,6 +46,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
44
46
  | [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership |
45
47
  | [**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents |
46
48
  | [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
49
+ | [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
47
50
  | [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
48
51
  | [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
49
52
  | [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
@@ -67,11 +70,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
67
70
  | [**stock_bidask**](DefaultApi.md#stock_bidask) | **GET** /stock/bidask | Last Bid-Ask |
68
71
  | [**stock_candles**](DefaultApi.md#stock_candles) | **GET** /stock/candle | Stock Candles |
69
72
  | [**stock_dividends**](DefaultApi.md#stock_dividends) | **GET** /stock/dividend | Dividends |
73
+ | [**stock_lobbying**](DefaultApi.md#stock_lobbying) | **GET** /stock/lobbying | Senate Lobbying |
70
74
  | [**stock_nbbo**](DefaultApi.md#stock_nbbo) | **GET** /stock/bbo | Historical NBBO |
71
75
  | [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
72
76
  | [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
73
77
  | [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
74
78
  | [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
79
+ | [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
75
80
  | [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
76
81
  | [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
77
82
  | [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
@@ -154,6 +159,158 @@ end
154
159
  - **Accept**: application/json
155
160
 
156
161
 
162
+ ## bond_price
163
+
164
+ > <BondCandles> bond_price(isin, from, to)
165
+
166
+ Bond price data
167
+
168
+ Get end-of-day bond's price data.
169
+
170
+ ### Examples
171
+
172
+ ```ruby
173
+ require 'time'
174
+ require 'finnhub_ruby'
175
+ # setup authorization
176
+ FinnhubRuby.configure do |config|
177
+ # Configure API key authorization: api_key
178
+ config.api_key['api_key'] = 'YOUR API KEY'
179
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
180
+ # config.api_key_prefix['api_key'] = 'Bearer'
181
+ end
182
+
183
+ api_instance = FinnhubRuby::DefaultApi.new
184
+ isin = 'isin_example' # String | ISIN.
185
+ from = 789 # Integer | UNIX timestamp. Interval initial value.
186
+ to = 789 # Integer | UNIX timestamp. Interval end value.
187
+
188
+ begin
189
+ # Bond price data
190
+ result = api_instance.bond_price(isin, from, to)
191
+ p result
192
+ rescue FinnhubRuby::ApiError => e
193
+ puts "Error when calling DefaultApi->bond_price: #{e}"
194
+ end
195
+ ```
196
+
197
+ #### Using the bond_price_with_http_info variant
198
+
199
+ This returns an Array which contains the response data, status code and headers.
200
+
201
+ > <Array(<BondCandles>, Integer, Hash)> bond_price_with_http_info(isin, from, to)
202
+
203
+ ```ruby
204
+ begin
205
+ # Bond price data
206
+ data, status_code, headers = api_instance.bond_price_with_http_info(isin, from, to)
207
+ p status_code # => 2xx
208
+ p headers # => { ... }
209
+ p data # => <BondCandles>
210
+ rescue FinnhubRuby::ApiError => e
211
+ puts "Error when calling DefaultApi->bond_price_with_http_info: #{e}"
212
+ end
213
+ ```
214
+
215
+ ### Parameters
216
+
217
+ | Name | Type | Description | Notes |
218
+ | ---- | ---- | ----------- | ----- |
219
+ | **isin** | **String** | ISIN. | |
220
+ | **from** | **Integer** | UNIX timestamp. Interval initial value. | |
221
+ | **to** | **Integer** | UNIX timestamp. Interval end value. | |
222
+
223
+ ### Return type
224
+
225
+ [**BondCandles**](BondCandles.md)
226
+
227
+ ### Authorization
228
+
229
+ [api_key](../README.md#api_key)
230
+
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: Not defined
234
+ - **Accept**: application/json
235
+
236
+
237
+ ## bond_profile
238
+
239
+ > <BondProfile> bond_profile(opts)
240
+
241
+ Bond Profile
242
+
243
+ Get general information of a bond. You can query by FIGI, ISIN or CUSIP
244
+
245
+ ### Examples
246
+
247
+ ```ruby
248
+ require 'time'
249
+ require 'finnhub_ruby'
250
+ # setup authorization
251
+ FinnhubRuby.configure do |config|
252
+ # Configure API key authorization: api_key
253
+ config.api_key['api_key'] = 'YOUR API KEY'
254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
255
+ # config.api_key_prefix['api_key'] = 'Bearer'
256
+ end
257
+
258
+ api_instance = FinnhubRuby::DefaultApi.new
259
+ opts = {
260
+ isin: 'isin_example', # String | ISIN
261
+ cusip: 'cusip_example', # String | CUSIP
262
+ figi: 'figi_example' # String | FIGI
263
+ }
264
+
265
+ begin
266
+ # Bond Profile
267
+ result = api_instance.bond_profile(opts)
268
+ p result
269
+ rescue FinnhubRuby::ApiError => e
270
+ puts "Error when calling DefaultApi->bond_profile: #{e}"
271
+ end
272
+ ```
273
+
274
+ #### Using the bond_profile_with_http_info variant
275
+
276
+ This returns an Array which contains the response data, status code and headers.
277
+
278
+ > <Array(<BondProfile>, Integer, Hash)> bond_profile_with_http_info(opts)
279
+
280
+ ```ruby
281
+ begin
282
+ # Bond Profile
283
+ data, status_code, headers = api_instance.bond_profile_with_http_info(opts)
284
+ p status_code # => 2xx
285
+ p headers # => { ... }
286
+ p data # => <BondProfile>
287
+ rescue FinnhubRuby::ApiError => e
288
+ puts "Error when calling DefaultApi->bond_profile_with_http_info: #{e}"
289
+ end
290
+ ```
291
+
292
+ ### Parameters
293
+
294
+ | Name | Type | Description | Notes |
295
+ | ---- | ---- | ----------- | ----- |
296
+ | **isin** | **String** | ISIN | [optional] |
297
+ | **cusip** | **String** | CUSIP | [optional] |
298
+ | **figi** | **String** | FIGI | [optional] |
299
+
300
+ ### Return type
301
+
302
+ [**BondProfile**](BondProfile.md)
303
+
304
+ ### Authorization
305
+
306
+ [api_key](../README.md#api_key)
307
+
308
+ ### HTTP request headers
309
+
310
+ - **Content-Type**: Not defined
311
+ - **Accept**: application/json
312
+
313
+
157
314
  ## company_basic_financials
158
315
 
159
316
  > <BasicFinancials> company_basic_financials(symbol, metric)
@@ -1929,7 +2086,8 @@ api_instance = FinnhubRuby::DefaultApi.new
1929
2086
  opts = {
1930
2087
  symbol: 'symbol_example', # String | ETF symbol.
1931
2088
  isin: 'isin_example', # String | ETF isin.
1932
- skip: 789 # Integer | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
2089
+ skip: 789, # Integer | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
2090
+ date: 'date_example' # String | Query holdings by date. You can use either this param or <code>skip</code> param, not both.
1933
2091
  }
1934
2092
 
1935
2093
  begin
@@ -1966,6 +2124,7 @@ end
1966
2124
  | **symbol** | **String** | ETF symbol. | [optional] |
1967
2125
  | **isin** | **String** | ETF isin. | [optional] |
1968
2126
  | **skip** | **Integer** | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip&#x3D;0 or not set. | [optional] |
2127
+ | **date** | **String** | Query holdings by date. You can use either this param or &lt;code&gt;skip&lt;/code&gt; param, not both. | [optional] |
1969
2128
 
1970
2129
  ### Return type
1971
2130
 
@@ -2671,7 +2830,8 @@ end
2671
2830
 
2672
2831
  api_instance = FinnhubRuby::DefaultApi.new
2673
2832
  opts = {
2674
- base: 'base_example' # String | Base currency. Default to EUR.
2833
+ base: 'base_example', # String | Base currency. Default to EUR.
2834
+ date: 'date_example' # String | Date. Leave blank to get the latest data.
2675
2835
  }
2676
2836
 
2677
2837
  begin
@@ -2706,6 +2866,7 @@ end
2706
2866
  | Name | Type | Description | Notes |
2707
2867
  | ---- | ---- | ----------- | ----- |
2708
2868
  | **base** | **String** | Base currency. Default to EUR. | [optional] |
2869
+ | **date** | **String** | Date. Leave blank to get the latest data. | [optional] |
2709
2870
 
2710
2871
  ### Return type
2711
2872
 
@@ -2944,7 +3105,7 @@ end
2944
3105
 
2945
3106
  Indices Historical Constituents
2946
3107
 
2947
- Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC (S&P 500)</code>, <code>^NDX (Nasdaq 100)</code>, <code>^DJI (Dow Jones)</code>
3108
+ Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>
2948
3109
 
2949
3110
  ### Examples
2950
3111
 
@@ -3009,6 +3170,81 @@ end
3009
3170
  - **Accept**: application/json
3010
3171
 
3011
3172
 
3173
+ ## insider_sentiment
3174
+
3175
+ > <InsiderSentiments> insider_sentiment(symbol, from, to)
3176
+
3177
+ Insider Sentiment
3178
+
3179
+ Get insider sentiment data for US companies calculated using method discussed <a href=\"https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a\" target=\"_blank\">here</a>. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.
3180
+
3181
+ ### Examples
3182
+
3183
+ ```ruby
3184
+ require 'time'
3185
+ require 'finnhub_ruby'
3186
+ # setup authorization
3187
+ FinnhubRuby.configure do |config|
3188
+ # Configure API key authorization: api_key
3189
+ config.api_key['api_key'] = 'YOUR API KEY'
3190
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3191
+ # config.api_key_prefix['api_key'] = 'Bearer'
3192
+ end
3193
+
3194
+ api_instance = FinnhubRuby::DefaultApi.new
3195
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
3196
+ from = Date.parse('2013-10-20') # Date | From date: 2020-03-15.
3197
+ to = Date.parse('2013-10-20') # Date | To date: 2020-03-16.
3198
+
3199
+ begin
3200
+ # Insider Sentiment
3201
+ result = api_instance.insider_sentiment(symbol, from, to)
3202
+ p result
3203
+ rescue FinnhubRuby::ApiError => e
3204
+ puts "Error when calling DefaultApi->insider_sentiment: #{e}"
3205
+ end
3206
+ ```
3207
+
3208
+ #### Using the insider_sentiment_with_http_info variant
3209
+
3210
+ This returns an Array which contains the response data, status code and headers.
3211
+
3212
+ > <Array(<InsiderSentiments>, Integer, Hash)> insider_sentiment_with_http_info(symbol, from, to)
3213
+
3214
+ ```ruby
3215
+ begin
3216
+ # Insider Sentiment
3217
+ data, status_code, headers = api_instance.insider_sentiment_with_http_info(symbol, from, to)
3218
+ p status_code # => 2xx
3219
+ p headers # => { ... }
3220
+ p data # => <InsiderSentiments>
3221
+ rescue FinnhubRuby::ApiError => e
3222
+ puts "Error when calling DefaultApi->insider_sentiment_with_http_info: #{e}"
3223
+ end
3224
+ ```
3225
+
3226
+ ### Parameters
3227
+
3228
+ | Name | Type | Description | Notes |
3229
+ | ---- | ---- | ----------- | ----- |
3230
+ | **symbol** | **String** | Symbol of the company: AAPL. | |
3231
+ | **from** | **Date** | From date: 2020-03-15. | |
3232
+ | **to** | **Date** | To date: 2020-03-16. | |
3233
+
3234
+ ### Return type
3235
+
3236
+ [**InsiderSentiments**](InsiderSentiments.md)
3237
+
3238
+ ### Authorization
3239
+
3240
+ [api_key](../README.md#api_key)
3241
+
3242
+ ### HTTP request headers
3243
+
3244
+ - **Content-Type**: Not defined
3245
+ - **Accept**: application/json
3246
+
3247
+
3012
3248
  ## insider_transactions
3013
3249
 
3014
3250
  > <InsiderTransactions> insider_transactions(symbol, opts)
@@ -4706,6 +4942,81 @@ end
4706
4942
  - **Accept**: application/json
4707
4943
 
4708
4944
 
4945
+ ## stock_lobbying
4946
+
4947
+ > <LobbyingResult> stock_lobbying(symbol, from, to)
4948
+
4949
+ Senate Lobbying
4950
+
4951
+ Get a list of reported lobbying activities in the Senate and the House.
4952
+
4953
+ ### Examples
4954
+
4955
+ ```ruby
4956
+ require 'time'
4957
+ require 'finnhub_ruby'
4958
+ # setup authorization
4959
+ FinnhubRuby.configure do |config|
4960
+ # Configure API key authorization: api_key
4961
+ config.api_key['api_key'] = 'YOUR API KEY'
4962
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4963
+ # config.api_key_prefix['api_key'] = 'Bearer'
4964
+ end
4965
+
4966
+ api_instance = FinnhubRuby::DefaultApi.new
4967
+ symbol = 'symbol_example' # String | Symbol.
4968
+ from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
4969
+ to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
4970
+
4971
+ begin
4972
+ # Senate Lobbying
4973
+ result = api_instance.stock_lobbying(symbol, from, to)
4974
+ p result
4975
+ rescue FinnhubRuby::ApiError => e
4976
+ puts "Error when calling DefaultApi->stock_lobbying: #{e}"
4977
+ end
4978
+ ```
4979
+
4980
+ #### Using the stock_lobbying_with_http_info variant
4981
+
4982
+ This returns an Array which contains the response data, status code and headers.
4983
+
4984
+ > <Array(<LobbyingResult>, Integer, Hash)> stock_lobbying_with_http_info(symbol, from, to)
4985
+
4986
+ ```ruby
4987
+ begin
4988
+ # Senate Lobbying
4989
+ data, status_code, headers = api_instance.stock_lobbying_with_http_info(symbol, from, to)
4990
+ p status_code # => 2xx
4991
+ p headers # => { ... }
4992
+ p data # => <LobbyingResult>
4993
+ rescue FinnhubRuby::ApiError => e
4994
+ puts "Error when calling DefaultApi->stock_lobbying_with_http_info: #{e}"
4995
+ end
4996
+ ```
4997
+
4998
+ ### Parameters
4999
+
5000
+ | Name | Type | Description | Notes |
5001
+ | ---- | ---- | ----------- | ----- |
5002
+ | **symbol** | **String** | Symbol. | |
5003
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | |
5004
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | |
5005
+
5006
+ ### Return type
5007
+
5008
+ [**LobbyingResult**](LobbyingResult.md)
5009
+
5010
+ ### Authorization
5011
+
5012
+ [api_key](../README.md#api_key)
5013
+
5014
+ ### HTTP request headers
5015
+
5016
+ - **Content-Type**: Not defined
5017
+ - **Accept**: application/json
5018
+
5019
+
4709
5020
  ## stock_nbbo
4710
5021
 
4711
5022
  > <HistoricalNBBO> stock_nbbo(symbol, date, limit, skip)
@@ -4864,7 +5175,7 @@ end
4864
5175
 
4865
5176
  Stock Symbol
4866
5177
 
4867
- List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>. A list of supported CFD Indices can be found <a href=\"https://docs.google.com/spreadsheets/d/1BAbIXBgl405fj0oHeEyRFEu8mW4QD1PhvtaBATLoR14/edit?usp=sharing\" target=\"_blank\">here</a>.
5178
+ List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
4868
5179
 
4869
5180
  ### Examples
4870
5181
 
@@ -4943,7 +5254,7 @@ end
4943
5254
 
4944
5255
  Tick Data
4945
5256
 
4946
- <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
5257
+ <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
4947
5258
 
4948
5259
  ### Examples
4949
5260
 
@@ -5089,13 +5400,88 @@ end
5089
5400
  - **Accept**: application/json
5090
5401
 
5091
5402
 
5403
+ ## stock_visa_application
5404
+
5405
+ > <VisaApplicationResult> stock_visa_application(symbol, from, to)
5406
+
5407
+ H1-B Visa Application
5408
+
5409
+ Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
5410
+
5411
+ ### Examples
5412
+
5413
+ ```ruby
5414
+ require 'time'
5415
+ require 'finnhub_ruby'
5416
+ # setup authorization
5417
+ FinnhubRuby.configure do |config|
5418
+ # Configure API key authorization: api_key
5419
+ config.api_key['api_key'] = 'YOUR API KEY'
5420
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5421
+ # config.api_key_prefix['api_key'] = 'Bearer'
5422
+ end
5423
+
5424
+ api_instance = FinnhubRuby::DefaultApi.new
5425
+ symbol = 'symbol_example' # String | Symbol.
5426
+ from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
5427
+ to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
5428
+
5429
+ begin
5430
+ # H1-B Visa Application
5431
+ result = api_instance.stock_visa_application(symbol, from, to)
5432
+ p result
5433
+ rescue FinnhubRuby::ApiError => e
5434
+ puts "Error when calling DefaultApi->stock_visa_application: #{e}"
5435
+ end
5436
+ ```
5437
+
5438
+ #### Using the stock_visa_application_with_http_info variant
5439
+
5440
+ This returns an Array which contains the response data, status code and headers.
5441
+
5442
+ > <Array(<VisaApplicationResult>, Integer, Hash)> stock_visa_application_with_http_info(symbol, from, to)
5443
+
5444
+ ```ruby
5445
+ begin
5446
+ # H1-B Visa Application
5447
+ data, status_code, headers = api_instance.stock_visa_application_with_http_info(symbol, from, to)
5448
+ p status_code # => 2xx
5449
+ p headers # => { ... }
5450
+ p data # => <VisaApplicationResult>
5451
+ rescue FinnhubRuby::ApiError => e
5452
+ puts "Error when calling DefaultApi->stock_visa_application_with_http_info: #{e}"
5453
+ end
5454
+ ```
5455
+
5456
+ ### Parameters
5457
+
5458
+ | Name | Type | Description | Notes |
5459
+ | ---- | ---- | ----------- | ----- |
5460
+ | **symbol** | **String** | Symbol. | |
5461
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column. | |
5462
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column. | |
5463
+
5464
+ ### Return type
5465
+
5466
+ [**VisaApplicationResult**](VisaApplicationResult.md)
5467
+
5468
+ ### Authorization
5469
+
5470
+ [api_key](../README.md#api_key)
5471
+
5472
+ ### HTTP request headers
5473
+
5474
+ - **Content-Type**: Not defined
5475
+ - **Accept**: application/json
5476
+
5477
+
5092
5478
  ## supply_chain_relationships
5093
5479
 
5094
5480
  > <SupplyChainRelationships> supply_chain_relationships(symbol)
5095
5481
 
5096
5482
  Supply Chain Relationships
5097
5483
 
5098
- <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p><p>We currently cover data for S&P500 and Nasdaq 100 companies.</p>
5484
+ <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p>
5099
5485
 
5100
5486
  ### Examples
5101
5487
 
@@ -5464,7 +5850,7 @@ end
5464
5850
 
5465
5851
  Earnings Call Transcripts List
5466
5852
 
5467
- List earnings call transcripts' metadata. This endpoint is available for US, UK and Canadian companies.
5853
+ List earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.
5468
5854
 
5469
5855
  ### Examples
5470
5856
 
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::InsiderSentiments
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol of the company. | [optional] |
8
+ | **data** | [**Array&lt;InsiderSentimentsData&gt;**](InsiderSentimentsData.md) | Array of sentiment data. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::InsiderSentiments.new(
16
+ symbol: null,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # FinnhubRuby::InsiderSentimentsData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **year** | **Integer** | Year. | [optional] |
9
+ | **month** | **Integer** | Month. | [optional] |
10
+ | **change** | **Integer** | Net buying/selling from all insiders&#39; transactions. | [optional] |
11
+ | **mspr** | **Float** | Monthly share purchase ratio. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'finnhub_ruby'
17
+
18
+ instance = FinnhubRuby::InsiderSentimentsData.new(
19
+ symbol: null,
20
+ year: null,
21
+ month: null,
22
+ change: null,
23
+ mspr: null
24
+ )
25
+ ```
26
+