finnhub_ruby 1.1.17 → 1.1.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/BondTickData.md +40 -0
- data/docs/BondYieldCurve.md +20 -0
- data/docs/BondYieldCurveInfo.md +20 -0
- data/docs/CompanyProfile.md +5 -1
- data/docs/CongressionalTrading.md +20 -0
- data/docs/CongressionalTransaction.md +36 -0
- data/docs/DefaultApi.md +849 -93
- data/docs/Dividends.md +3 -1
- data/docs/DocumentResponse.md +28 -0
- data/docs/ETFHoldingsData.md +3 -1
- data/docs/ETFProfileData.md +8 -2
- data/docs/EarningResult.md +5 -1
- data/docs/ExcerptResponse.md +24 -0
- data/docs/FilingResponse.md +42 -0
- data/docs/InFilingResponse.md +44 -0
- data/docs/InFilingSearchBody.md +20 -0
- data/docs/InstitutionalOwnership.md +22 -0
- data/docs/InstitutionalOwnershipGroup.md +20 -0
- data/docs/InstitutionalOwnershipInfo.md +36 -0
- data/docs/InstitutionalPortfolio.md +22 -0
- data/docs/InstitutionalPortfolioGroup.md +22 -0
- data/docs/InstitutionalPortfolioInfo.md +38 -0
- data/docs/InstitutionalProfile.md +20 -0
- data/docs/InstitutionalProfileInfo.md +28 -0
- data/docs/IsinChange.md +22 -0
- data/docs/IsinChangeInfo.md +22 -0
- data/docs/MutualFundEet.md +20 -0
- data/docs/MutualFundEetPai.md +20 -0
- data/docs/MutualFundHoldingsData.md +3 -1
- data/docs/PriceMetrics.md +22 -0
- data/docs/SearchBody.md +60 -0
- data/docs/SearchFilter.md +20 -0
- data/docs/SearchResponse.md +24 -0
- data/docs/SymbolChange.md +22 -0
- data/docs/SymbolChangeInfo.md +22 -0
- data/finnhub_ruby-1.1.17.gem +0 -0
- data/finnhub_ruby-1.1.18.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +835 -95
- data/lib/finnhub_ruby/models/bond_tick_data.rb +347 -0
- data/lib/finnhub_ruby/models/bond_yield_curve.rb +231 -0
- data/lib/finnhub_ruby/models/bond_yield_curve_info.rb +229 -0
- data/lib/finnhub_ruby/models/company_profile.rb +22 -2
- data/lib/finnhub_ruby/models/congressional_trading.rb +231 -0
- data/lib/finnhub_ruby/models/congressional_transaction.rb +309 -0
- data/lib/finnhub_ruby/models/dividends.rb +14 -4
- data/lib/finnhub_ruby/models/document_response.rb +271 -0
- data/lib/finnhub_ruby/models/earning_result.rb +24 -4
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +14 -4
- data/lib/finnhub_ruby/models/etf_profile_data.rb +35 -5
- data/lib/finnhub_ruby/models/excerpt_response.rb +249 -0
- data/lib/finnhub_ruby/models/filing_response.rb +339 -0
- data/lib/finnhub_ruby/models/in_filing_response.rb +351 -0
- data/lib/finnhub_ruby/models/in_filing_search_body.rb +239 -0
- data/lib/finnhub_ruby/models/institutional_ownership.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_ownership_group.rb +231 -0
- data/lib/finnhub_ruby/models/institutional_ownership_info.rb +309 -0
- data/lib/finnhub_ruby/models/institutional_portfolio.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_portfolio_group.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_portfolio_info.rb +319 -0
- data/lib/finnhub_ruby/models/institutional_profile.rb +231 -0
- data/lib/finnhub_ruby/models/institutional_profile_info.rb +269 -0
- data/lib/finnhub_ruby/models/isin_change.rb +241 -0
- data/lib/finnhub_ruby/models/isin_change_info.rb +239 -0
- data/lib/finnhub_ruby/models/mutual_fund_eet.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_eet_pai.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +14 -4
- data/lib/finnhub_ruby/models/price_metrics.rb +238 -0
- data/lib/finnhub_ruby/models/search_body.rb +434 -0
- data/lib/finnhub_ruby/models/search_filter.rb +229 -0
- data/lib/finnhub_ruby/models/search_response.rb +251 -0
- data/lib/finnhub_ruby/models/symbol_change.rb +241 -0
- data/lib/finnhub_ruby/models/symbol_change_info.rb +239 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +28 -0
- data/spec/models/bond_tick_data_spec.rb +82 -0
- data/spec/models/bond_yield_curve_info_spec.rb +40 -0
- data/spec/models/bond_yield_curve_spec.rb +40 -0
- data/spec/models/congressional_trading_spec.rb +40 -0
- data/spec/models/congressional_transaction_spec.rb +88 -0
- data/spec/models/document_response_spec.rb +64 -0
- data/spec/models/excerpt_response_spec.rb +52 -0
- data/spec/models/filing_response_spec.rb +106 -0
- data/spec/models/in_filing_response_spec.rb +112 -0
- data/spec/models/in_filing_search_body_spec.rb +40 -0
- data/spec/models/institutional_ownership_group_spec.rb +40 -0
- data/spec/models/institutional_ownership_info_spec.rb +88 -0
- data/spec/models/institutional_ownership_spec.rb +46 -0
- data/spec/models/institutional_portfolio_group_spec.rb +46 -0
- data/spec/models/institutional_portfolio_info_spec.rb +94 -0
- data/spec/models/institutional_portfolio_spec.rb +46 -0
- data/spec/models/institutional_profile_info_spec.rb +64 -0
- data/spec/models/institutional_profile_spec.rb +40 -0
- data/spec/models/isin_change_info_spec.rb +46 -0
- data/spec/models/isin_change_spec.rb +46 -0
- data/spec/models/mutual_fund_eet_pai_spec.rb +40 -0
- data/spec/models/mutual_fund_eet_spec.rb +40 -0
- data/spec/models/price_metrics_spec.rb +40 -0
- data/spec/models/search_body_spec.rb +160 -0
- data/spec/models/search_filter_spec.rb +40 -0
- data/spec/models/search_response_spec.rb +52 -0
- data/spec/models/symbol_change_info_spec.rb +46 -0
- data/spec/models/symbol_change_spec.rb +46 -0
- metadata +117 -3
|
@@ -20,7 +20,7 @@ module FinnhubRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Aggregate Indicators
|
|
23
|
-
# Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
|
|
23
|
+
# Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.
|
|
24
24
|
# @param symbol [String] symbol
|
|
25
25
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module FinnhubRuby
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Aggregate Indicators
|
|
34
|
-
# Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
|
|
34
|
+
# Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.
|
|
35
35
|
# @param symbol [String] symbol
|
|
36
36
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -91,7 +91,7 @@ module FinnhubRuby
|
|
|
91
91
|
end
|
|
92
92
|
|
|
93
93
|
# Bond price data
|
|
94
|
-
# Get
|
|
94
|
+
# <p>Get bond's price data. The following datasets are supported:</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 Government Bonds</th> <td>Government Bonds</td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
|
95
95
|
# @param isin [String] ISIN.
|
|
96
96
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
|
97
97
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
|
@@ -103,7 +103,7 @@ module FinnhubRuby
|
|
|
103
103
|
end
|
|
104
104
|
|
|
105
105
|
# Bond price data
|
|
106
|
-
# Get
|
|
106
|
+
# <p>Get bond's price data. The following datasets are supported:</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 Government Bonds</th> <td>Government Bonds</td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
|
107
107
|
# @param isin [String] ISIN.
|
|
108
108
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
|
109
109
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
|
@@ -169,7 +169,7 @@ module FinnhubRuby
|
|
|
169
169
|
end
|
|
170
170
|
|
|
171
171
|
# Bond Profile
|
|
172
|
-
# Get general information of a bond. You can query by FIGI, ISIN or CUSIP
|
|
172
|
+
# Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.
|
|
173
173
|
# @param [Hash] opts the optional parameters
|
|
174
174
|
# @option opts [String] :isin ISIN
|
|
175
175
|
# @option opts [String] :cusip CUSIP
|
|
@@ -181,7 +181,7 @@ module FinnhubRuby
|
|
|
181
181
|
end
|
|
182
182
|
|
|
183
183
|
# Bond Profile
|
|
184
|
-
# Get general information of a bond. You can query by FIGI, ISIN or CUSIP
|
|
184
|
+
# Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.
|
|
185
185
|
# @param [Hash] opts the optional parameters
|
|
186
186
|
# @option opts [String] :isin ISIN
|
|
187
187
|
# @option opts [String] :cusip CUSIP
|
|
@@ -234,6 +234,162 @@ module FinnhubRuby
|
|
|
234
234
|
return data, status_code, headers
|
|
235
235
|
end
|
|
236
236
|
|
|
237
|
+
# Bond Tick Data
|
|
238
|
+
# <p>Get trade-level data for bonds. The following datasets are supported:</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\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
|
239
|
+
# @param isin [String] ISIN.
|
|
240
|
+
# @param date [Date] Date: 2020-04-02.
|
|
241
|
+
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
242
|
+
# @param skip [Integer] Number of ticks to skip. Use this parameter to loop through the entire data.
|
|
243
|
+
# @param exchange [String] Currently support the following values: <code>trace</code>.
|
|
244
|
+
# @param [Hash] opts the optional parameters
|
|
245
|
+
# @return [BondTickData]
|
|
246
|
+
def bond_tick(isin, date, limit, skip, exchange, opts = {})
|
|
247
|
+
data, _status_code, _headers = bond_tick_with_http_info(isin, date, limit, skip, exchange, opts)
|
|
248
|
+
data
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
# Bond Tick Data
|
|
252
|
+
# <p>Get trade-level data for bonds. The following datasets are supported:</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\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
|
253
|
+
# @param isin [String] ISIN.
|
|
254
|
+
# @param date [Date] Date: 2020-04-02.
|
|
255
|
+
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
256
|
+
# @param skip [Integer] Number of ticks to skip. Use this parameter to loop through the entire data.
|
|
257
|
+
# @param exchange [String] Currently support the following values: <code>trace</code>.
|
|
258
|
+
# @param [Hash] opts the optional parameters
|
|
259
|
+
# @return [Array<(BondTickData, Integer, Hash)>] BondTickData data, response status code and response headers
|
|
260
|
+
def bond_tick_with_http_info(isin, date, limit, skip, exchange, opts = {})
|
|
261
|
+
if @api_client.config.debugging
|
|
262
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.bond_tick ...'
|
|
263
|
+
end
|
|
264
|
+
# verify the required parameter 'isin' is set
|
|
265
|
+
if @api_client.config.client_side_validation && isin.nil?
|
|
266
|
+
fail ArgumentError, "Missing the required parameter 'isin' when calling DefaultApi.bond_tick"
|
|
267
|
+
end
|
|
268
|
+
# verify the required parameter 'date' is set
|
|
269
|
+
if @api_client.config.client_side_validation && date.nil?
|
|
270
|
+
fail ArgumentError, "Missing the required parameter 'date' when calling DefaultApi.bond_tick"
|
|
271
|
+
end
|
|
272
|
+
# verify the required parameter 'limit' is set
|
|
273
|
+
if @api_client.config.client_side_validation && limit.nil?
|
|
274
|
+
fail ArgumentError, "Missing the required parameter 'limit' when calling DefaultApi.bond_tick"
|
|
275
|
+
end
|
|
276
|
+
# verify the required parameter 'skip' is set
|
|
277
|
+
if @api_client.config.client_side_validation && skip.nil?
|
|
278
|
+
fail ArgumentError, "Missing the required parameter 'skip' when calling DefaultApi.bond_tick"
|
|
279
|
+
end
|
|
280
|
+
# verify the required parameter 'exchange' is set
|
|
281
|
+
if @api_client.config.client_side_validation && exchange.nil?
|
|
282
|
+
fail ArgumentError, "Missing the required parameter 'exchange' when calling DefaultApi.bond_tick"
|
|
283
|
+
end
|
|
284
|
+
# resource path
|
|
285
|
+
local_var_path = '/bond/tick'
|
|
286
|
+
|
|
287
|
+
# query parameters
|
|
288
|
+
query_params = opts[:query_params] || {}
|
|
289
|
+
query_params[:'isin'] = isin
|
|
290
|
+
query_params[:'date'] = date
|
|
291
|
+
query_params[:'limit'] = limit
|
|
292
|
+
query_params[:'skip'] = skip
|
|
293
|
+
query_params[:'exchange'] = exchange
|
|
294
|
+
|
|
295
|
+
# header parameters
|
|
296
|
+
header_params = opts[:header_params] || {}
|
|
297
|
+
# HTTP header 'Accept' (if needed)
|
|
298
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
299
|
+
|
|
300
|
+
# form parameters
|
|
301
|
+
form_params = opts[:form_params] || {}
|
|
302
|
+
|
|
303
|
+
# http body (model)
|
|
304
|
+
post_body = opts[:debug_body]
|
|
305
|
+
|
|
306
|
+
# return_type
|
|
307
|
+
return_type = opts[:debug_return_type] || 'BondTickData'
|
|
308
|
+
|
|
309
|
+
# auth_names
|
|
310
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
311
|
+
|
|
312
|
+
new_options = opts.merge(
|
|
313
|
+
:operation => :"DefaultApi.bond_tick",
|
|
314
|
+
:header_params => header_params,
|
|
315
|
+
:query_params => query_params,
|
|
316
|
+
:form_params => form_params,
|
|
317
|
+
:body => post_body,
|
|
318
|
+
:auth_names => auth_names,
|
|
319
|
+
:return_type => return_type
|
|
320
|
+
)
|
|
321
|
+
|
|
322
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
323
|
+
if @api_client.config.debugging
|
|
324
|
+
@api_client.config.logger.debug "API called: DefaultApi#bond_tick\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
325
|
+
end
|
|
326
|
+
return data, status_code, headers
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
# Bond Yield Curve
|
|
330
|
+
# Get yield curve data for Treasury bonds.
|
|
331
|
+
# @param code [String] Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.
|
|
332
|
+
# @param [Hash] opts the optional parameters
|
|
333
|
+
# @return [BondYieldCurve]
|
|
334
|
+
def bond_yield_curve(code, opts = {})
|
|
335
|
+
data, _status_code, _headers = bond_yield_curve_with_http_info(code, opts)
|
|
336
|
+
data
|
|
337
|
+
end
|
|
338
|
+
|
|
339
|
+
# Bond Yield Curve
|
|
340
|
+
# Get yield curve data for Treasury bonds.
|
|
341
|
+
# @param code [String] Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.
|
|
342
|
+
# @param [Hash] opts the optional parameters
|
|
343
|
+
# @return [Array<(BondYieldCurve, Integer, Hash)>] BondYieldCurve data, response status code and response headers
|
|
344
|
+
def bond_yield_curve_with_http_info(code, opts = {})
|
|
345
|
+
if @api_client.config.debugging
|
|
346
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.bond_yield_curve ...'
|
|
347
|
+
end
|
|
348
|
+
# verify the required parameter 'code' is set
|
|
349
|
+
if @api_client.config.client_side_validation && code.nil?
|
|
350
|
+
fail ArgumentError, "Missing the required parameter 'code' when calling DefaultApi.bond_yield_curve"
|
|
351
|
+
end
|
|
352
|
+
# resource path
|
|
353
|
+
local_var_path = '/bond/yield-curve'
|
|
354
|
+
|
|
355
|
+
# query parameters
|
|
356
|
+
query_params = opts[:query_params] || {}
|
|
357
|
+
query_params[:'code'] = code
|
|
358
|
+
|
|
359
|
+
# header parameters
|
|
360
|
+
header_params = opts[:header_params] || {}
|
|
361
|
+
# HTTP header 'Accept' (if needed)
|
|
362
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
363
|
+
|
|
364
|
+
# form parameters
|
|
365
|
+
form_params = opts[:form_params] || {}
|
|
366
|
+
|
|
367
|
+
# http body (model)
|
|
368
|
+
post_body = opts[:debug_body]
|
|
369
|
+
|
|
370
|
+
# return_type
|
|
371
|
+
return_type = opts[:debug_return_type] || 'BondYieldCurve'
|
|
372
|
+
|
|
373
|
+
# auth_names
|
|
374
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
375
|
+
|
|
376
|
+
new_options = opts.merge(
|
|
377
|
+
:operation => :"DefaultApi.bond_yield_curve",
|
|
378
|
+
:header_params => header_params,
|
|
379
|
+
:query_params => query_params,
|
|
380
|
+
:form_params => form_params,
|
|
381
|
+
:body => post_body,
|
|
382
|
+
:auth_names => auth_names,
|
|
383
|
+
:return_type => return_type
|
|
384
|
+
)
|
|
385
|
+
|
|
386
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
387
|
+
if @api_client.config.debugging
|
|
388
|
+
@api_client.config.logger.debug "API called: DefaultApi#bond_yield_curve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
389
|
+
end
|
|
390
|
+
return data, status_code, headers
|
|
391
|
+
end
|
|
392
|
+
|
|
237
393
|
# Basic Financials
|
|
238
394
|
# Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
|
|
239
395
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -851,9 +1007,10 @@ module FinnhubRuby
|
|
|
851
1007
|
end
|
|
852
1008
|
|
|
853
1009
|
# Peers
|
|
854
|
-
# Get company peers. Return a list of peers in the same country and
|
|
1010
|
+
# Get company peers. Return a list of peers operating in the same country and sector/industry.
|
|
855
1011
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
856
1012
|
# @param [Hash] opts the optional parameters
|
|
1013
|
+
# @option opts [String] :grouping Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>.
|
|
857
1014
|
# @return [Array<String>]
|
|
858
1015
|
def company_peers(symbol, opts = {})
|
|
859
1016
|
data, _status_code, _headers = company_peers_with_http_info(symbol, opts)
|
|
@@ -861,9 +1018,10 @@ module FinnhubRuby
|
|
|
861
1018
|
end
|
|
862
1019
|
|
|
863
1020
|
# Peers
|
|
864
|
-
# Get company peers. Return a list of peers in the same country and
|
|
1021
|
+
# Get company peers. Return a list of peers operating in the same country and sector/industry.
|
|
865
1022
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
866
1023
|
# @param [Hash] opts the optional parameters
|
|
1024
|
+
# @option opts [String] :grouping Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>.
|
|
867
1025
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
|
868
1026
|
def company_peers_with_http_info(symbol, opts = {})
|
|
869
1027
|
if @api_client.config.debugging
|
|
@@ -879,6 +1037,7 @@ module FinnhubRuby
|
|
|
879
1037
|
# query parameters
|
|
880
1038
|
query_params = opts[:query_params] || {}
|
|
881
1039
|
query_params[:'symbol'] = symbol
|
|
1040
|
+
query_params[:'grouping'] = opts[:'grouping'] if !opts[:'grouping'].nil?
|
|
882
1041
|
|
|
883
1042
|
# header parameters
|
|
884
1043
|
header_params = opts[:header_params] || {}
|
|
@@ -1113,6 +1272,84 @@ module FinnhubRuby
|
|
|
1113
1272
|
return data, status_code, headers
|
|
1114
1273
|
end
|
|
1115
1274
|
|
|
1275
|
+
# Congressional Trading
|
|
1276
|
+
# Get stock trades data disclosed by members of congress.
|
|
1277
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
1278
|
+
# @param from [Date] From date <code>YYYY-MM-DD</code>.
|
|
1279
|
+
# @param to [Date] To date <code>YYYY-MM-DD</code>.
|
|
1280
|
+
# @param [Hash] opts the optional parameters
|
|
1281
|
+
# @return [CongressionalTrading]
|
|
1282
|
+
def congressional_trading(symbol, from, to, opts = {})
|
|
1283
|
+
data, _status_code, _headers = congressional_trading_with_http_info(symbol, from, to, opts)
|
|
1284
|
+
data
|
|
1285
|
+
end
|
|
1286
|
+
|
|
1287
|
+
# Congressional Trading
|
|
1288
|
+
# Get stock trades data disclosed by members of congress.
|
|
1289
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
1290
|
+
# @param from [Date] From date <code>YYYY-MM-DD</code>.
|
|
1291
|
+
# @param to [Date] To date <code>YYYY-MM-DD</code>.
|
|
1292
|
+
# @param [Hash] opts the optional parameters
|
|
1293
|
+
# @return [Array<(CongressionalTrading, Integer, Hash)>] CongressionalTrading data, response status code and response headers
|
|
1294
|
+
def congressional_trading_with_http_info(symbol, from, to, opts = {})
|
|
1295
|
+
if @api_client.config.debugging
|
|
1296
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.congressional_trading ...'
|
|
1297
|
+
end
|
|
1298
|
+
# verify the required parameter 'symbol' is set
|
|
1299
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
1300
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.congressional_trading"
|
|
1301
|
+
end
|
|
1302
|
+
# verify the required parameter 'from' is set
|
|
1303
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
1304
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.congressional_trading"
|
|
1305
|
+
end
|
|
1306
|
+
# verify the required parameter 'to' is set
|
|
1307
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
1308
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.congressional_trading"
|
|
1309
|
+
end
|
|
1310
|
+
# resource path
|
|
1311
|
+
local_var_path = '/stock/congressional-trading'
|
|
1312
|
+
|
|
1313
|
+
# query parameters
|
|
1314
|
+
query_params = opts[:query_params] || {}
|
|
1315
|
+
query_params[:'symbol'] = symbol
|
|
1316
|
+
query_params[:'from'] = from
|
|
1317
|
+
query_params[:'to'] = to
|
|
1318
|
+
|
|
1319
|
+
# header parameters
|
|
1320
|
+
header_params = opts[:header_params] || {}
|
|
1321
|
+
# HTTP header 'Accept' (if needed)
|
|
1322
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1323
|
+
|
|
1324
|
+
# form parameters
|
|
1325
|
+
form_params = opts[:form_params] || {}
|
|
1326
|
+
|
|
1327
|
+
# http body (model)
|
|
1328
|
+
post_body = opts[:debug_body]
|
|
1329
|
+
|
|
1330
|
+
# return_type
|
|
1331
|
+
return_type = opts[:debug_return_type] || 'CongressionalTrading'
|
|
1332
|
+
|
|
1333
|
+
# auth_names
|
|
1334
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
1335
|
+
|
|
1336
|
+
new_options = opts.merge(
|
|
1337
|
+
:operation => :"DefaultApi.congressional_trading",
|
|
1338
|
+
:header_params => header_params,
|
|
1339
|
+
:query_params => query_params,
|
|
1340
|
+
:form_params => form_params,
|
|
1341
|
+
:body => post_body,
|
|
1342
|
+
:auth_names => auth_names,
|
|
1343
|
+
:return_type => return_type
|
|
1344
|
+
)
|
|
1345
|
+
|
|
1346
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1347
|
+
if @api_client.config.debugging
|
|
1348
|
+
@api_client.config.logger.debug "API called: DefaultApi#congressional_trading\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1349
|
+
end
|
|
1350
|
+
return data, status_code, headers
|
|
1351
|
+
end
|
|
1352
|
+
|
|
1116
1353
|
# Country Metadata
|
|
1117
1354
|
# List all countries and metadata.
|
|
1118
1355
|
# @param [Hash] opts the optional parameters
|
|
@@ -1815,7 +2052,7 @@ module FinnhubRuby
|
|
|
1815
2052
|
end
|
|
1816
2053
|
|
|
1817
2054
|
# ETFs Holdings
|
|
1818
|
-
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
|
2055
|
+
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
|
1819
2056
|
# @param [Hash] opts the optional parameters
|
|
1820
2057
|
# @option opts [String] :symbol ETF symbol.
|
|
1821
2058
|
# @option opts [String] :isin ETF isin.
|
|
@@ -1828,7 +2065,7 @@ module FinnhubRuby
|
|
|
1828
2065
|
end
|
|
1829
2066
|
|
|
1830
2067
|
# ETFs Holdings
|
|
1831
|
-
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
|
2068
|
+
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
|
1832
2069
|
# @param [Hash] opts the optional parameters
|
|
1833
2070
|
# @option opts [String] :symbol ETF symbol.
|
|
1834
2071
|
# @option opts [String] :isin ETF isin.
|
|
@@ -1884,7 +2121,7 @@ module FinnhubRuby
|
|
|
1884
2121
|
end
|
|
1885
2122
|
|
|
1886
2123
|
# ETFs Profile
|
|
1887
|
-
# Get ETF profile information. This endpoint has global coverage.
|
|
2124
|
+
# Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
|
1888
2125
|
# @param [Hash] opts the optional parameters
|
|
1889
2126
|
# @option opts [String] :symbol ETF symbol.
|
|
1890
2127
|
# @option opts [String] :isin ETF isin.
|
|
@@ -1895,7 +2132,7 @@ module FinnhubRuby
|
|
|
1895
2132
|
end
|
|
1896
2133
|
|
|
1897
2134
|
# ETFs Profile
|
|
1898
|
-
# Get ETF profile information. This endpoint has global coverage.
|
|
2135
|
+
# Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
|
1899
2136
|
# @param [Hash] opts the optional parameters
|
|
1900
2137
|
# @option opts [String] :symbol ETF symbol.
|
|
1901
2138
|
# @option opts [String] :isin ETF isin.
|
|
@@ -2291,6 +2528,8 @@ module FinnhubRuby
|
|
|
2291
2528
|
# @option opts [String] :cik CIK.
|
|
2292
2529
|
# @option opts [String] :access_number Access number of a specific report you want to retrieve financials from.
|
|
2293
2530
|
# @option opts [String] :freq Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
|
2531
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>. Filter for endDate.
|
|
2532
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>. Filter for endDate.
|
|
2294
2533
|
# @return [FinancialsAsReported]
|
|
2295
2534
|
def financials_reported(opts = {})
|
|
2296
2535
|
data, _status_code, _headers = financials_reported_with_http_info(opts)
|
|
@@ -2304,6 +2543,8 @@ module FinnhubRuby
|
|
|
2304
2543
|
# @option opts [String] :cik CIK.
|
|
2305
2544
|
# @option opts [String] :access_number Access number of a specific report you want to retrieve financials from.
|
|
2306
2545
|
# @option opts [String] :freq Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
|
2546
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>. Filter for endDate.
|
|
2547
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>. Filter for endDate.
|
|
2307
2548
|
# @return [Array<(FinancialsAsReported, Integer, Hash)>] FinancialsAsReported data, response status code and response headers
|
|
2308
2549
|
def financials_reported_with_http_info(opts = {})
|
|
2309
2550
|
if @api_client.config.debugging
|
|
@@ -2318,6 +2559,8 @@ module FinnhubRuby
|
|
|
2318
2559
|
query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
|
|
2319
2560
|
query_params[:'accessNumber'] = opts[:'access_number'] if !opts[:'access_number'].nil?
|
|
2320
2561
|
query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
|
|
2562
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
2563
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
2321
2564
|
|
|
2322
2565
|
# header parameters
|
|
2323
2566
|
header_params = opts[:header_params] || {}
|
|
@@ -2896,7 +3139,7 @@ module FinnhubRuby
|
|
|
2896
3139
|
end
|
|
2897
3140
|
|
|
2898
3141
|
# Insider Transactions
|
|
2899
|
-
# Company insider transactions data sourced from <code>Form 3,4,5</code
|
|
3142
|
+
# Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, Canada, Australia, and selected EU companies. Limit to 100 transactions per API call.
|
|
2900
3143
|
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2901
3144
|
# @param [Hash] opts the optional parameters
|
|
2902
3145
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
@@ -2908,7 +3151,7 @@ module FinnhubRuby
|
|
|
2908
3151
|
end
|
|
2909
3152
|
|
|
2910
3153
|
# Insider Transactions
|
|
2911
|
-
# Company insider transactions data sourced from <code>Form 3,4,5</code>
|
|
3154
|
+
# Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, Canada, Australia, and selected EU companies. Limit to 100 transactions per API call.
|
|
2912
3155
|
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2913
3156
|
# @param [Hash] opts the optional parameters
|
|
2914
3157
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
@@ -2965,34 +3208,56 @@ module FinnhubRuby
|
|
|
2965
3208
|
return data, status_code, headers
|
|
2966
3209
|
end
|
|
2967
3210
|
|
|
2968
|
-
#
|
|
2969
|
-
#
|
|
3211
|
+
# Institutional Ownership
|
|
3212
|
+
# Get a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
|
|
3213
|
+
# @param symbol [String] Filter by symbol.
|
|
3214
|
+
# @param cusip [String] Filter by CUSIP.
|
|
3215
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3216
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
2970
3217
|
# @param [Hash] opts the optional parameters
|
|
2971
|
-
# @
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
def international_filings(opts = {})
|
|
2975
|
-
data, _status_code, _headers = international_filings_with_http_info(opts)
|
|
3218
|
+
# @return [InstitutionalOwnership]
|
|
3219
|
+
def institutional_ownership(symbol, cusip, from, to, opts = {})
|
|
3220
|
+
data, _status_code, _headers = institutional_ownership_with_http_info(symbol, cusip, from, to, opts)
|
|
2976
3221
|
data
|
|
2977
3222
|
end
|
|
2978
3223
|
|
|
2979
|
-
#
|
|
2980
|
-
#
|
|
3224
|
+
# Institutional Ownership
|
|
3225
|
+
# Get a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
|
|
3226
|
+
# @param symbol [String] Filter by symbol.
|
|
3227
|
+
# @param cusip [String] Filter by CUSIP.
|
|
3228
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3229
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
2981
3230
|
# @param [Hash] opts the optional parameters
|
|
2982
|
-
# @
|
|
2983
|
-
|
|
2984
|
-
# @return [Array<(Array<InternationalFiling>, Integer, Hash)>] Array<InternationalFiling> data, response status code and response headers
|
|
2985
|
-
def international_filings_with_http_info(opts = {})
|
|
3231
|
+
# @return [Array<(InstitutionalOwnership, Integer, Hash)>] InstitutionalOwnership data, response status code and response headers
|
|
3232
|
+
def institutional_ownership_with_http_info(symbol, cusip, from, to, opts = {})
|
|
2986
3233
|
if @api_client.config.debugging
|
|
2987
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
|
3234
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.institutional_ownership ...'
|
|
3235
|
+
end
|
|
3236
|
+
# verify the required parameter 'symbol' is set
|
|
3237
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
3238
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.institutional_ownership"
|
|
3239
|
+
end
|
|
3240
|
+
# verify the required parameter 'cusip' is set
|
|
3241
|
+
if @api_client.config.client_side_validation && cusip.nil?
|
|
3242
|
+
fail ArgumentError, "Missing the required parameter 'cusip' when calling DefaultApi.institutional_ownership"
|
|
3243
|
+
end
|
|
3244
|
+
# verify the required parameter 'from' is set
|
|
3245
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
3246
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.institutional_ownership"
|
|
3247
|
+
end
|
|
3248
|
+
# verify the required parameter 'to' is set
|
|
3249
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
3250
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.institutional_ownership"
|
|
2988
3251
|
end
|
|
2989
3252
|
# resource path
|
|
2990
|
-
local_var_path = '/
|
|
3253
|
+
local_var_path = '/institutional/ownership'
|
|
2991
3254
|
|
|
2992
3255
|
# query parameters
|
|
2993
3256
|
query_params = opts[:query_params] || {}
|
|
2994
|
-
query_params[:'symbol'] =
|
|
2995
|
-
query_params[:'
|
|
3257
|
+
query_params[:'symbol'] = symbol
|
|
3258
|
+
query_params[:'cusip'] = cusip
|
|
3259
|
+
query_params[:'from'] = from
|
|
3260
|
+
query_params[:'to'] = to
|
|
2996
3261
|
|
|
2997
3262
|
# header parameters
|
|
2998
3263
|
header_params = opts[:header_params] || {}
|
|
@@ -3006,13 +3271,13 @@ module FinnhubRuby
|
|
|
3006
3271
|
post_body = opts[:debug_body]
|
|
3007
3272
|
|
|
3008
3273
|
# return_type
|
|
3009
|
-
return_type = opts[:debug_return_type] || '
|
|
3274
|
+
return_type = opts[:debug_return_type] || 'InstitutionalOwnership'
|
|
3010
3275
|
|
|
3011
3276
|
# auth_names
|
|
3012
3277
|
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3013
3278
|
|
|
3014
3279
|
new_options = opts.merge(
|
|
3015
|
-
:operation => :"DefaultApi.
|
|
3280
|
+
:operation => :"DefaultApi.institutional_ownership",
|
|
3016
3281
|
:header_params => header_params,
|
|
3017
3282
|
:query_params => query_params,
|
|
3018
3283
|
:form_params => form_params,
|
|
@@ -3023,40 +3288,54 @@ module FinnhubRuby
|
|
|
3023
3288
|
|
|
3024
3289
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3025
3290
|
if @api_client.config.debugging
|
|
3026
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
|
3291
|
+
@api_client.config.logger.debug "API called: DefaultApi#institutional_ownership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3027
3292
|
end
|
|
3028
3293
|
return data, status_code, headers
|
|
3029
3294
|
end
|
|
3030
3295
|
|
|
3031
|
-
#
|
|
3032
|
-
#
|
|
3033
|
-
# @param
|
|
3296
|
+
# Institutional Portfolio
|
|
3297
|
+
# Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.
|
|
3298
|
+
# @param cik [String] Fund's CIK.
|
|
3299
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3300
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
3034
3301
|
# @param [Hash] opts the optional parameters
|
|
3035
|
-
# @return [
|
|
3036
|
-
def
|
|
3037
|
-
data, _status_code, _headers =
|
|
3302
|
+
# @return [InstitutionalPortfolio]
|
|
3303
|
+
def institutional_portfolio(cik, from, to, opts = {})
|
|
3304
|
+
data, _status_code, _headers = institutional_portfolio_with_http_info(cik, from, to, opts)
|
|
3038
3305
|
data
|
|
3039
3306
|
end
|
|
3040
3307
|
|
|
3041
|
-
#
|
|
3042
|
-
#
|
|
3043
|
-
# @param
|
|
3308
|
+
# Institutional Portfolio
|
|
3309
|
+
# Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.
|
|
3310
|
+
# @param cik [String] Fund's CIK.
|
|
3311
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3312
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
3044
3313
|
# @param [Hash] opts the optional parameters
|
|
3045
|
-
# @return [Array<(
|
|
3046
|
-
def
|
|
3314
|
+
# @return [Array<(InstitutionalPortfolio, Integer, Hash)>] InstitutionalPortfolio data, response status code and response headers
|
|
3315
|
+
def institutional_portfolio_with_http_info(cik, from, to, opts = {})
|
|
3047
3316
|
if @api_client.config.debugging
|
|
3048
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
|
3317
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.institutional_portfolio ...'
|
|
3049
3318
|
end
|
|
3050
|
-
# verify the required parameter '
|
|
3051
|
-
if @api_client.config.client_side_validation &&
|
|
3052
|
-
fail ArgumentError, "Missing the required parameter '
|
|
3319
|
+
# verify the required parameter 'cik' is set
|
|
3320
|
+
if @api_client.config.client_side_validation && cik.nil?
|
|
3321
|
+
fail ArgumentError, "Missing the required parameter 'cik' when calling DefaultApi.institutional_portfolio"
|
|
3322
|
+
end
|
|
3323
|
+
# verify the required parameter 'from' is set
|
|
3324
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
3325
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.institutional_portfolio"
|
|
3326
|
+
end
|
|
3327
|
+
# verify the required parameter 'to' is set
|
|
3328
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
3329
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.institutional_portfolio"
|
|
3053
3330
|
end
|
|
3054
3331
|
# resource path
|
|
3055
|
-
local_var_path = '/
|
|
3332
|
+
local_var_path = '/institutional/portfolio'
|
|
3056
3333
|
|
|
3057
3334
|
# query parameters
|
|
3058
3335
|
query_params = opts[:query_params] || {}
|
|
3059
|
-
query_params[:'
|
|
3336
|
+
query_params[:'cik'] = cik
|
|
3337
|
+
query_params[:'from'] = from
|
|
3338
|
+
query_params[:'to'] = to
|
|
3060
3339
|
|
|
3061
3340
|
# header parameters
|
|
3062
3341
|
header_params = opts[:header_params] || {}
|
|
@@ -3070,13 +3349,13 @@ module FinnhubRuby
|
|
|
3070
3349
|
post_body = opts[:debug_body]
|
|
3071
3350
|
|
|
3072
3351
|
# return_type
|
|
3073
|
-
return_type = opts[:debug_return_type] || '
|
|
3352
|
+
return_type = opts[:debug_return_type] || 'InstitutionalPortfolio'
|
|
3074
3353
|
|
|
3075
3354
|
# auth_names
|
|
3076
3355
|
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3077
3356
|
|
|
3078
3357
|
new_options = opts.merge(
|
|
3079
|
-
:operation => :"DefaultApi.
|
|
3358
|
+
:operation => :"DefaultApi.institutional_portfolio",
|
|
3080
3359
|
:header_params => header_params,
|
|
3081
3360
|
:query_params => query_params,
|
|
3082
3361
|
:form_params => form_params,
|
|
@@ -3087,47 +3366,36 @@ module FinnhubRuby
|
|
|
3087
3366
|
|
|
3088
3367
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3089
3368
|
if @api_client.config.debugging
|
|
3090
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
|
3369
|
+
@api_client.config.logger.debug "API called: DefaultApi#institutional_portfolio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3091
3370
|
end
|
|
3092
3371
|
return data, status_code, headers
|
|
3093
3372
|
end
|
|
3094
3373
|
|
|
3095
|
-
#
|
|
3096
|
-
# Get
|
|
3097
|
-
# @param from [Date] From date: 2020-03-15.
|
|
3098
|
-
# @param to [Date] To date: 2020-03-16.
|
|
3374
|
+
# Institutional Profile
|
|
3375
|
+
# Get a list of well-known institutional investors. Currently support 60+ profiles.
|
|
3099
3376
|
# @param [Hash] opts the optional parameters
|
|
3100
|
-
# @
|
|
3101
|
-
|
|
3102
|
-
|
|
3377
|
+
# @option opts [String] :cik Filter by CIK. Leave blank to get the full list.
|
|
3378
|
+
# @return [InstitutionalProfile]
|
|
3379
|
+
def institutional_profile(opts = {})
|
|
3380
|
+
data, _status_code, _headers = institutional_profile_with_http_info(opts)
|
|
3103
3381
|
data
|
|
3104
3382
|
end
|
|
3105
3383
|
|
|
3106
|
-
#
|
|
3107
|
-
# Get
|
|
3108
|
-
# @param from [Date] From date: 2020-03-15.
|
|
3109
|
-
# @param to [Date] To date: 2020-03-16.
|
|
3384
|
+
# Institutional Profile
|
|
3385
|
+
# Get a list of well-known institutional investors. Currently support 60+ profiles.
|
|
3110
3386
|
# @param [Hash] opts the optional parameters
|
|
3111
|
-
# @
|
|
3112
|
-
|
|
3387
|
+
# @option opts [String] :cik Filter by CIK. Leave blank to get the full list.
|
|
3388
|
+
# @return [Array<(InstitutionalProfile, Integer, Hash)>] InstitutionalProfile data, response status code and response headers
|
|
3389
|
+
def institutional_profile_with_http_info(opts = {})
|
|
3113
3390
|
if @api_client.config.debugging
|
|
3114
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
|
3115
|
-
end
|
|
3116
|
-
# verify the required parameter 'from' is set
|
|
3117
|
-
if @api_client.config.client_side_validation && from.nil?
|
|
3118
|
-
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.ipo_calendar"
|
|
3119
|
-
end
|
|
3120
|
-
# verify the required parameter 'to' is set
|
|
3121
|
-
if @api_client.config.client_side_validation && to.nil?
|
|
3122
|
-
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.ipo_calendar"
|
|
3391
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.institutional_profile ...'
|
|
3123
3392
|
end
|
|
3124
3393
|
# resource path
|
|
3125
|
-
local_var_path = '/
|
|
3394
|
+
local_var_path = '/institutional/profile'
|
|
3126
3395
|
|
|
3127
3396
|
# query parameters
|
|
3128
3397
|
query_params = opts[:query_params] || {}
|
|
3129
|
-
query_params[:'
|
|
3130
|
-
query_params[:'to'] = to
|
|
3398
|
+
query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
|
|
3131
3399
|
|
|
3132
3400
|
# header parameters
|
|
3133
3401
|
header_params = opts[:header_params] || {}
|
|
@@ -3141,13 +3409,13 @@ module FinnhubRuby
|
|
|
3141
3409
|
post_body = opts[:debug_body]
|
|
3142
3410
|
|
|
3143
3411
|
# return_type
|
|
3144
|
-
return_type = opts[:debug_return_type] || '
|
|
3412
|
+
return_type = opts[:debug_return_type] || 'InstitutionalProfile'
|
|
3145
3413
|
|
|
3146
3414
|
# auth_names
|
|
3147
3415
|
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3148
3416
|
|
|
3149
3417
|
new_options = opts.merge(
|
|
3150
|
-
:operation => :"DefaultApi.
|
|
3418
|
+
:operation => :"DefaultApi.institutional_profile",
|
|
3151
3419
|
:header_params => header_params,
|
|
3152
3420
|
:query_params => query_params,
|
|
3153
3421
|
:form_params => form_params,
|
|
@@ -3158,15 +3426,221 @@ module FinnhubRuby
|
|
|
3158
3426
|
|
|
3159
3427
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3160
3428
|
if @api_client.config.debugging
|
|
3161
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
|
3429
|
+
@api_client.config.logger.debug "API called: DefaultApi#institutional_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3162
3430
|
end
|
|
3163
3431
|
return data, status_code, headers
|
|
3164
3432
|
end
|
|
3165
3433
|
|
|
3166
|
-
#
|
|
3167
|
-
#
|
|
3168
|
-
# @param
|
|
3169
|
-
# @param [Hash] opts the optional parameters
|
|
3434
|
+
# Investment Themes (Thematic Investing)
|
|
3435
|
+
# <p>Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.</p><p>This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.</p><p>A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.</p>
|
|
3436
|
+
# @param theme [String] Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.
|
|
3437
|
+
# @param [Hash] opts the optional parameters
|
|
3438
|
+
# @return [InvestmentThemes]
|
|
3439
|
+
def investment_themes(theme, opts = {})
|
|
3440
|
+
data, _status_code, _headers = investment_themes_with_http_info(theme, opts)
|
|
3441
|
+
data
|
|
3442
|
+
end
|
|
3443
|
+
|
|
3444
|
+
# Investment Themes (Thematic Investing)
|
|
3445
|
+
# <p>Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.</p><p>This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.</p><p>A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.</p>
|
|
3446
|
+
# @param theme [String] Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.
|
|
3447
|
+
# @param [Hash] opts the optional parameters
|
|
3448
|
+
# @return [Array<(InvestmentThemes, Integer, Hash)>] InvestmentThemes data, response status code and response headers
|
|
3449
|
+
def investment_themes_with_http_info(theme, opts = {})
|
|
3450
|
+
if @api_client.config.debugging
|
|
3451
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.investment_themes ...'
|
|
3452
|
+
end
|
|
3453
|
+
# verify the required parameter 'theme' is set
|
|
3454
|
+
if @api_client.config.client_side_validation && theme.nil?
|
|
3455
|
+
fail ArgumentError, "Missing the required parameter 'theme' when calling DefaultApi.investment_themes"
|
|
3456
|
+
end
|
|
3457
|
+
# resource path
|
|
3458
|
+
local_var_path = '/stock/investment-theme'
|
|
3459
|
+
|
|
3460
|
+
# query parameters
|
|
3461
|
+
query_params = opts[:query_params] || {}
|
|
3462
|
+
query_params[:'theme'] = theme
|
|
3463
|
+
|
|
3464
|
+
# header parameters
|
|
3465
|
+
header_params = opts[:header_params] || {}
|
|
3466
|
+
# HTTP header 'Accept' (if needed)
|
|
3467
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3468
|
+
|
|
3469
|
+
# form parameters
|
|
3470
|
+
form_params = opts[:form_params] || {}
|
|
3471
|
+
|
|
3472
|
+
# http body (model)
|
|
3473
|
+
post_body = opts[:debug_body]
|
|
3474
|
+
|
|
3475
|
+
# return_type
|
|
3476
|
+
return_type = opts[:debug_return_type] || 'InvestmentThemes'
|
|
3477
|
+
|
|
3478
|
+
# auth_names
|
|
3479
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3480
|
+
|
|
3481
|
+
new_options = opts.merge(
|
|
3482
|
+
:operation => :"DefaultApi.investment_themes",
|
|
3483
|
+
:header_params => header_params,
|
|
3484
|
+
:query_params => query_params,
|
|
3485
|
+
:form_params => form_params,
|
|
3486
|
+
:body => post_body,
|
|
3487
|
+
:auth_names => auth_names,
|
|
3488
|
+
:return_type => return_type
|
|
3489
|
+
)
|
|
3490
|
+
|
|
3491
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3492
|
+
if @api_client.config.debugging
|
|
3493
|
+
@api_client.config.logger.debug "API called: DefaultApi#investment_themes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3494
|
+
end
|
|
3495
|
+
return data, status_code, headers
|
|
3496
|
+
end
|
|
3497
|
+
|
|
3498
|
+
# IPO Calendar
|
|
3499
|
+
# Get recent and upcoming IPO.
|
|
3500
|
+
# @param from [Date] From date: 2020-03-15.
|
|
3501
|
+
# @param to [Date] To date: 2020-03-16.
|
|
3502
|
+
# @param [Hash] opts the optional parameters
|
|
3503
|
+
# @return [IPOCalendar]
|
|
3504
|
+
def ipo_calendar(from, to, opts = {})
|
|
3505
|
+
data, _status_code, _headers = ipo_calendar_with_http_info(from, to, opts)
|
|
3506
|
+
data
|
|
3507
|
+
end
|
|
3508
|
+
|
|
3509
|
+
# IPO Calendar
|
|
3510
|
+
# Get recent and upcoming IPO.
|
|
3511
|
+
# @param from [Date] From date: 2020-03-15.
|
|
3512
|
+
# @param to [Date] To date: 2020-03-16.
|
|
3513
|
+
# @param [Hash] opts the optional parameters
|
|
3514
|
+
# @return [Array<(IPOCalendar, Integer, Hash)>] IPOCalendar data, response status code and response headers
|
|
3515
|
+
def ipo_calendar_with_http_info(from, to, opts = {})
|
|
3516
|
+
if @api_client.config.debugging
|
|
3517
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.ipo_calendar ...'
|
|
3518
|
+
end
|
|
3519
|
+
# verify the required parameter 'from' is set
|
|
3520
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
3521
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.ipo_calendar"
|
|
3522
|
+
end
|
|
3523
|
+
# verify the required parameter 'to' is set
|
|
3524
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
3525
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.ipo_calendar"
|
|
3526
|
+
end
|
|
3527
|
+
# resource path
|
|
3528
|
+
local_var_path = '/calendar/ipo'
|
|
3529
|
+
|
|
3530
|
+
# query parameters
|
|
3531
|
+
query_params = opts[:query_params] || {}
|
|
3532
|
+
query_params[:'from'] = from
|
|
3533
|
+
query_params[:'to'] = to
|
|
3534
|
+
|
|
3535
|
+
# header parameters
|
|
3536
|
+
header_params = opts[:header_params] || {}
|
|
3537
|
+
# HTTP header 'Accept' (if needed)
|
|
3538
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3539
|
+
|
|
3540
|
+
# form parameters
|
|
3541
|
+
form_params = opts[:form_params] || {}
|
|
3542
|
+
|
|
3543
|
+
# http body (model)
|
|
3544
|
+
post_body = opts[:debug_body]
|
|
3545
|
+
|
|
3546
|
+
# return_type
|
|
3547
|
+
return_type = opts[:debug_return_type] || 'IPOCalendar'
|
|
3548
|
+
|
|
3549
|
+
# auth_names
|
|
3550
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3551
|
+
|
|
3552
|
+
new_options = opts.merge(
|
|
3553
|
+
:operation => :"DefaultApi.ipo_calendar",
|
|
3554
|
+
:header_params => header_params,
|
|
3555
|
+
:query_params => query_params,
|
|
3556
|
+
:form_params => form_params,
|
|
3557
|
+
:body => post_body,
|
|
3558
|
+
:auth_names => auth_names,
|
|
3559
|
+
:return_type => return_type
|
|
3560
|
+
)
|
|
3561
|
+
|
|
3562
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3563
|
+
if @api_client.config.debugging
|
|
3564
|
+
@api_client.config.logger.debug "API called: DefaultApi#ipo_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3565
|
+
end
|
|
3566
|
+
return data, status_code, headers
|
|
3567
|
+
end
|
|
3568
|
+
|
|
3569
|
+
# ISIN Change
|
|
3570
|
+
# Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
|
|
3571
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3572
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
3573
|
+
# @param [Hash] opts the optional parameters
|
|
3574
|
+
# @return [IsinChange]
|
|
3575
|
+
def isin_change(from, to, opts = {})
|
|
3576
|
+
data, _status_code, _headers = isin_change_with_http_info(from, to, opts)
|
|
3577
|
+
data
|
|
3578
|
+
end
|
|
3579
|
+
|
|
3580
|
+
# ISIN Change
|
|
3581
|
+
# Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
|
|
3582
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
3583
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
3584
|
+
# @param [Hash] opts the optional parameters
|
|
3585
|
+
# @return [Array<(IsinChange, Integer, Hash)>] IsinChange data, response status code and response headers
|
|
3586
|
+
def isin_change_with_http_info(from, to, opts = {})
|
|
3587
|
+
if @api_client.config.debugging
|
|
3588
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.isin_change ...'
|
|
3589
|
+
end
|
|
3590
|
+
# verify the required parameter 'from' is set
|
|
3591
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
3592
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.isin_change"
|
|
3593
|
+
end
|
|
3594
|
+
# verify the required parameter 'to' is set
|
|
3595
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
3596
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.isin_change"
|
|
3597
|
+
end
|
|
3598
|
+
# resource path
|
|
3599
|
+
local_var_path = '/ca/isin-change'
|
|
3600
|
+
|
|
3601
|
+
# query parameters
|
|
3602
|
+
query_params = opts[:query_params] || {}
|
|
3603
|
+
query_params[:'from'] = from
|
|
3604
|
+
query_params[:'to'] = to
|
|
3605
|
+
|
|
3606
|
+
# header parameters
|
|
3607
|
+
header_params = opts[:header_params] || {}
|
|
3608
|
+
# HTTP header 'Accept' (if needed)
|
|
3609
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3610
|
+
|
|
3611
|
+
# form parameters
|
|
3612
|
+
form_params = opts[:form_params] || {}
|
|
3613
|
+
|
|
3614
|
+
# http body (model)
|
|
3615
|
+
post_body = opts[:debug_body]
|
|
3616
|
+
|
|
3617
|
+
# return_type
|
|
3618
|
+
return_type = opts[:debug_return_type] || 'IsinChange'
|
|
3619
|
+
|
|
3620
|
+
# auth_names
|
|
3621
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3622
|
+
|
|
3623
|
+
new_options = opts.merge(
|
|
3624
|
+
:operation => :"DefaultApi.isin_change",
|
|
3625
|
+
:header_params => header_params,
|
|
3626
|
+
:query_params => query_params,
|
|
3627
|
+
:form_params => form_params,
|
|
3628
|
+
:body => post_body,
|
|
3629
|
+
:auth_names => auth_names,
|
|
3630
|
+
:return_type => return_type
|
|
3631
|
+
)
|
|
3632
|
+
|
|
3633
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3634
|
+
if @api_client.config.debugging
|
|
3635
|
+
@api_client.config.logger.debug "API called: DefaultApi#isin_change\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3636
|
+
end
|
|
3637
|
+
return data, status_code, headers
|
|
3638
|
+
end
|
|
3639
|
+
|
|
3640
|
+
# Market News
|
|
3641
|
+
# Get latest market news.
|
|
3642
|
+
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
|
3643
|
+
# @param [Hash] opts the optional parameters
|
|
3170
3644
|
# @option opts [Integer] :min_id Use this field to get only news after this ID. Default to 0
|
|
3171
3645
|
# @return [Array<MarketNews>]
|
|
3172
3646
|
def market_news(category, opts = {})
|
|
@@ -3294,8 +3768,136 @@ module FinnhubRuby
|
|
|
3294
3768
|
return data, status_code, headers
|
|
3295
3769
|
end
|
|
3296
3770
|
|
|
3771
|
+
# Mutual Funds EET
|
|
3772
|
+
# Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
|
|
3773
|
+
# @param isin [String] ISIN.
|
|
3774
|
+
# @param [Hash] opts the optional parameters
|
|
3775
|
+
# @return [MutualFundEet]
|
|
3776
|
+
def mutual_fund_eet(isin, opts = {})
|
|
3777
|
+
data, _status_code, _headers = mutual_fund_eet_with_http_info(isin, opts)
|
|
3778
|
+
data
|
|
3779
|
+
end
|
|
3780
|
+
|
|
3781
|
+
# Mutual Funds EET
|
|
3782
|
+
# Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
|
|
3783
|
+
# @param isin [String] ISIN.
|
|
3784
|
+
# @param [Hash] opts the optional parameters
|
|
3785
|
+
# @return [Array<(MutualFundEet, Integer, Hash)>] MutualFundEet data, response status code and response headers
|
|
3786
|
+
def mutual_fund_eet_with_http_info(isin, opts = {})
|
|
3787
|
+
if @api_client.config.debugging
|
|
3788
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_eet ...'
|
|
3789
|
+
end
|
|
3790
|
+
# verify the required parameter 'isin' is set
|
|
3791
|
+
if @api_client.config.client_side_validation && isin.nil?
|
|
3792
|
+
fail ArgumentError, "Missing the required parameter 'isin' when calling DefaultApi.mutual_fund_eet"
|
|
3793
|
+
end
|
|
3794
|
+
# resource path
|
|
3795
|
+
local_var_path = '/mutual-fund/eet'
|
|
3796
|
+
|
|
3797
|
+
# query parameters
|
|
3798
|
+
query_params = opts[:query_params] || {}
|
|
3799
|
+
query_params[:'isin'] = isin
|
|
3800
|
+
|
|
3801
|
+
# header parameters
|
|
3802
|
+
header_params = opts[:header_params] || {}
|
|
3803
|
+
# HTTP header 'Accept' (if needed)
|
|
3804
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3805
|
+
|
|
3806
|
+
# form parameters
|
|
3807
|
+
form_params = opts[:form_params] || {}
|
|
3808
|
+
|
|
3809
|
+
# http body (model)
|
|
3810
|
+
post_body = opts[:debug_body]
|
|
3811
|
+
|
|
3812
|
+
# return_type
|
|
3813
|
+
return_type = opts[:debug_return_type] || 'MutualFundEet'
|
|
3814
|
+
|
|
3815
|
+
# auth_names
|
|
3816
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3817
|
+
|
|
3818
|
+
new_options = opts.merge(
|
|
3819
|
+
:operation => :"DefaultApi.mutual_fund_eet",
|
|
3820
|
+
:header_params => header_params,
|
|
3821
|
+
:query_params => query_params,
|
|
3822
|
+
:form_params => form_params,
|
|
3823
|
+
:body => post_body,
|
|
3824
|
+
:auth_names => auth_names,
|
|
3825
|
+
:return_type => return_type
|
|
3826
|
+
)
|
|
3827
|
+
|
|
3828
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3829
|
+
if @api_client.config.debugging
|
|
3830
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_eet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3831
|
+
end
|
|
3832
|
+
return data, status_code, headers
|
|
3833
|
+
end
|
|
3834
|
+
|
|
3835
|
+
# Mutual Funds EET PAI
|
|
3836
|
+
# Get EET PAI data for EU funds.
|
|
3837
|
+
# @param isin [String] ISIN.
|
|
3838
|
+
# @param [Hash] opts the optional parameters
|
|
3839
|
+
# @return [MutualFundEetPai]
|
|
3840
|
+
def mutual_fund_eet_pai(isin, opts = {})
|
|
3841
|
+
data, _status_code, _headers = mutual_fund_eet_pai_with_http_info(isin, opts)
|
|
3842
|
+
data
|
|
3843
|
+
end
|
|
3844
|
+
|
|
3845
|
+
# Mutual Funds EET PAI
|
|
3846
|
+
# Get EET PAI data for EU funds.
|
|
3847
|
+
# @param isin [String] ISIN.
|
|
3848
|
+
# @param [Hash] opts the optional parameters
|
|
3849
|
+
# @return [Array<(MutualFundEetPai, Integer, Hash)>] MutualFundEetPai data, response status code and response headers
|
|
3850
|
+
def mutual_fund_eet_pai_with_http_info(isin, opts = {})
|
|
3851
|
+
if @api_client.config.debugging
|
|
3852
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_eet_pai ...'
|
|
3853
|
+
end
|
|
3854
|
+
# verify the required parameter 'isin' is set
|
|
3855
|
+
if @api_client.config.client_side_validation && isin.nil?
|
|
3856
|
+
fail ArgumentError, "Missing the required parameter 'isin' when calling DefaultApi.mutual_fund_eet_pai"
|
|
3857
|
+
end
|
|
3858
|
+
# resource path
|
|
3859
|
+
local_var_path = '/mutual-fund/eet-pai'
|
|
3860
|
+
|
|
3861
|
+
# query parameters
|
|
3862
|
+
query_params = opts[:query_params] || {}
|
|
3863
|
+
query_params[:'isin'] = isin
|
|
3864
|
+
|
|
3865
|
+
# header parameters
|
|
3866
|
+
header_params = opts[:header_params] || {}
|
|
3867
|
+
# HTTP header 'Accept' (if needed)
|
|
3868
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3869
|
+
|
|
3870
|
+
# form parameters
|
|
3871
|
+
form_params = opts[:form_params] || {}
|
|
3872
|
+
|
|
3873
|
+
# http body (model)
|
|
3874
|
+
post_body = opts[:debug_body]
|
|
3875
|
+
|
|
3876
|
+
# return_type
|
|
3877
|
+
return_type = opts[:debug_return_type] || 'MutualFundEetPai'
|
|
3878
|
+
|
|
3879
|
+
# auth_names
|
|
3880
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
3881
|
+
|
|
3882
|
+
new_options = opts.merge(
|
|
3883
|
+
:operation => :"DefaultApi.mutual_fund_eet_pai",
|
|
3884
|
+
:header_params => header_params,
|
|
3885
|
+
:query_params => query_params,
|
|
3886
|
+
:form_params => form_params,
|
|
3887
|
+
:body => post_body,
|
|
3888
|
+
:auth_names => auth_names,
|
|
3889
|
+
:return_type => return_type
|
|
3890
|
+
)
|
|
3891
|
+
|
|
3892
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3893
|
+
if @api_client.config.debugging
|
|
3894
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_eet_pai\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3895
|
+
end
|
|
3896
|
+
return data, status_code, headers
|
|
3897
|
+
end
|
|
3898
|
+
|
|
3297
3899
|
# Mutual Funds Holdings
|
|
3298
|
-
# Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
|
3900
|
+
# Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
|
3299
3901
|
# @param [Hash] opts the optional parameters
|
|
3300
3902
|
# @option opts [String] :symbol Fund's symbol.
|
|
3301
3903
|
# @option opts [String] :isin Fund's isin.
|
|
@@ -3307,7 +3909,7 @@ module FinnhubRuby
|
|
|
3307
3909
|
end
|
|
3308
3910
|
|
|
3309
3911
|
# Mutual Funds Holdings
|
|
3310
|
-
# Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
|
3912
|
+
# Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
|
3311
3913
|
# @param [Hash] opts the optional parameters
|
|
3312
3914
|
# @option opts [String] :symbol Fund's symbol.
|
|
3313
3915
|
# @option opts [String] :isin Fund's isin.
|
|
@@ -3361,7 +3963,7 @@ module FinnhubRuby
|
|
|
3361
3963
|
end
|
|
3362
3964
|
|
|
3363
3965
|
# Mutual Funds Profile
|
|
3364
|
-
# Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
|
3966
|
+
# Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
|
3365
3967
|
# @param [Hash] opts the optional parameters
|
|
3366
3968
|
# @option opts [String] :symbol Fund's symbol.
|
|
3367
3969
|
# @option opts [String] :isin Fund's isin.
|
|
@@ -3372,7 +3974,7 @@ module FinnhubRuby
|
|
|
3372
3974
|
end
|
|
3373
3975
|
|
|
3374
3976
|
# Mutual Funds Profile
|
|
3375
|
-
# Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
|
3977
|
+
# Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
|
3376
3978
|
# @param [Hash] opts the optional parameters
|
|
3377
3979
|
# @option opts [String] :symbol Fund's symbol.
|
|
3378
3980
|
# @option opts [String] :isin Fund's isin.
|
|
@@ -3759,6 +4361,73 @@ module FinnhubRuby
|
|
|
3759
4361
|
return data, status_code, headers
|
|
3760
4362
|
end
|
|
3761
4363
|
|
|
4364
|
+
# Price Metrics
|
|
4365
|
+
# Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
|
4366
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
4367
|
+
# @param [Hash] opts the optional parameters
|
|
4368
|
+
# @option opts [String] :date Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.
|
|
4369
|
+
# @return [PriceMetrics]
|
|
4370
|
+
def price_metrics(symbol, opts = {})
|
|
4371
|
+
data, _status_code, _headers = price_metrics_with_http_info(symbol, opts)
|
|
4372
|
+
data
|
|
4373
|
+
end
|
|
4374
|
+
|
|
4375
|
+
# Price Metrics
|
|
4376
|
+
# Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
|
4377
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
4378
|
+
# @param [Hash] opts the optional parameters
|
|
4379
|
+
# @option opts [String] :date Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.
|
|
4380
|
+
# @return [Array<(PriceMetrics, Integer, Hash)>] PriceMetrics data, response status code and response headers
|
|
4381
|
+
def price_metrics_with_http_info(symbol, opts = {})
|
|
4382
|
+
if @api_client.config.debugging
|
|
4383
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.price_metrics ...'
|
|
4384
|
+
end
|
|
4385
|
+
# verify the required parameter 'symbol' is set
|
|
4386
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
4387
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.price_metrics"
|
|
4388
|
+
end
|
|
4389
|
+
# resource path
|
|
4390
|
+
local_var_path = '/stock/price-metric'
|
|
4391
|
+
|
|
4392
|
+
# query parameters
|
|
4393
|
+
query_params = opts[:query_params] || {}
|
|
4394
|
+
query_params[:'symbol'] = symbol
|
|
4395
|
+
query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
|
|
4396
|
+
|
|
4397
|
+
# header parameters
|
|
4398
|
+
header_params = opts[:header_params] || {}
|
|
4399
|
+
# HTTP header 'Accept' (if needed)
|
|
4400
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4401
|
+
|
|
4402
|
+
# form parameters
|
|
4403
|
+
form_params = opts[:form_params] || {}
|
|
4404
|
+
|
|
4405
|
+
# http body (model)
|
|
4406
|
+
post_body = opts[:debug_body]
|
|
4407
|
+
|
|
4408
|
+
# return_type
|
|
4409
|
+
return_type = opts[:debug_return_type] || 'PriceMetrics'
|
|
4410
|
+
|
|
4411
|
+
# auth_names
|
|
4412
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
4413
|
+
|
|
4414
|
+
new_options = opts.merge(
|
|
4415
|
+
:operation => :"DefaultApi.price_metrics",
|
|
4416
|
+
:header_params => header_params,
|
|
4417
|
+
:query_params => query_params,
|
|
4418
|
+
:form_params => form_params,
|
|
4419
|
+
:body => post_body,
|
|
4420
|
+
:auth_names => auth_names,
|
|
4421
|
+
:return_type => return_type
|
|
4422
|
+
)
|
|
4423
|
+
|
|
4424
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4425
|
+
if @api_client.config.debugging
|
|
4426
|
+
@api_client.config.logger.debug "API called: DefaultApi#price_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4427
|
+
end
|
|
4428
|
+
return data, status_code, headers
|
|
4429
|
+
end
|
|
4430
|
+
|
|
3762
4431
|
# Price Target
|
|
3763
4432
|
# Get latest price target consensus.
|
|
3764
4433
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -4820,7 +5489,7 @@ module FinnhubRuby
|
|
|
4820
5489
|
end
|
|
4821
5490
|
|
|
4822
5491
|
# Tick Data
|
|
4823
|
-
# <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>
|
|
5492
|
+
# <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>End-of-day</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>
|
|
4824
5493
|
# @param symbol [String] Symbol.
|
|
4825
5494
|
# @param date [Date] Date: 2020-04-02.
|
|
4826
5495
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
@@ -4833,7 +5502,7 @@ module FinnhubRuby
|
|
|
4833
5502
|
end
|
|
4834
5503
|
|
|
4835
5504
|
# Tick Data
|
|
4836
|
-
# <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>
|
|
5505
|
+
# <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>End-of-day</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>
|
|
4837
5506
|
# @param symbol [String] Symbol.
|
|
4838
5507
|
# @param date [Date] Date: 2020-04-02.
|
|
4839
5508
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
@@ -5273,6 +5942,77 @@ module FinnhubRuby
|
|
|
5273
5942
|
return data, status_code, headers
|
|
5274
5943
|
end
|
|
5275
5944
|
|
|
5945
|
+
# Symbol Change
|
|
5946
|
+
# Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
|
5947
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
5948
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
5949
|
+
# @param [Hash] opts the optional parameters
|
|
5950
|
+
# @return [SymbolChange]
|
|
5951
|
+
def symbol_change(from, to, opts = {})
|
|
5952
|
+
data, _status_code, _headers = symbol_change_with_http_info(from, to, opts)
|
|
5953
|
+
data
|
|
5954
|
+
end
|
|
5955
|
+
|
|
5956
|
+
# Symbol Change
|
|
5957
|
+
# Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
|
5958
|
+
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
|
5959
|
+
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
|
5960
|
+
# @param [Hash] opts the optional parameters
|
|
5961
|
+
# @return [Array<(SymbolChange, Integer, Hash)>] SymbolChange data, response status code and response headers
|
|
5962
|
+
def symbol_change_with_http_info(from, to, opts = {})
|
|
5963
|
+
if @api_client.config.debugging
|
|
5964
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.symbol_change ...'
|
|
5965
|
+
end
|
|
5966
|
+
# verify the required parameter 'from' is set
|
|
5967
|
+
if @api_client.config.client_side_validation && from.nil?
|
|
5968
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.symbol_change"
|
|
5969
|
+
end
|
|
5970
|
+
# verify the required parameter 'to' is set
|
|
5971
|
+
if @api_client.config.client_side_validation && to.nil?
|
|
5972
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.symbol_change"
|
|
5973
|
+
end
|
|
5974
|
+
# resource path
|
|
5975
|
+
local_var_path = '/ca/symbol-change'
|
|
5976
|
+
|
|
5977
|
+
# query parameters
|
|
5978
|
+
query_params = opts[:query_params] || {}
|
|
5979
|
+
query_params[:'from'] = from
|
|
5980
|
+
query_params[:'to'] = to
|
|
5981
|
+
|
|
5982
|
+
# header parameters
|
|
5983
|
+
header_params = opts[:header_params] || {}
|
|
5984
|
+
# HTTP header 'Accept' (if needed)
|
|
5985
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5986
|
+
|
|
5987
|
+
# form parameters
|
|
5988
|
+
form_params = opts[:form_params] || {}
|
|
5989
|
+
|
|
5990
|
+
# http body (model)
|
|
5991
|
+
post_body = opts[:debug_body]
|
|
5992
|
+
|
|
5993
|
+
# return_type
|
|
5994
|
+
return_type = opts[:debug_return_type] || 'SymbolChange'
|
|
5995
|
+
|
|
5996
|
+
# auth_names
|
|
5997
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
5998
|
+
|
|
5999
|
+
new_options = opts.merge(
|
|
6000
|
+
:operation => :"DefaultApi.symbol_change",
|
|
6001
|
+
:header_params => header_params,
|
|
6002
|
+
:query_params => query_params,
|
|
6003
|
+
:form_params => form_params,
|
|
6004
|
+
:body => post_body,
|
|
6005
|
+
:auth_names => auth_names,
|
|
6006
|
+
:return_type => return_type
|
|
6007
|
+
)
|
|
6008
|
+
|
|
6009
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6010
|
+
if @api_client.config.debugging
|
|
6011
|
+
@api_client.config.logger.debug "API called: DefaultApi#symbol_change\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6012
|
+
end
|
|
6013
|
+
return data, status_code, headers
|
|
6014
|
+
end
|
|
6015
|
+
|
|
5276
6016
|
# Symbol Lookup
|
|
5277
6017
|
# Search for best-matching symbols based on your query. You can input anything from symbol, security's name to ISIN and Cusip.
|
|
5278
6018
|
# @param q [String] Query text can be symbol, name, isin, or cusip.
|
|
@@ -5426,7 +6166,7 @@ module FinnhubRuby
|
|
|
5426
6166
|
:return_type => return_type
|
|
5427
6167
|
)
|
|
5428
6168
|
|
|
5429
|
-
data, status_code, headers = @api_client.call_api(:
|
|
6169
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5430
6170
|
if @api_client.config.debugging
|
|
5431
6171
|
@api_client.config.logger.debug "API called: DefaultApi#technical_indicator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5432
6172
|
end
|
|
@@ -5434,7 +6174,7 @@ module FinnhubRuby
|
|
|
5434
6174
|
end
|
|
5435
6175
|
|
|
5436
6176
|
# Earnings Call Transcripts
|
|
5437
|
-
# <p>Get earnings call transcripts, audio and participants' list.
|
|
6177
|
+
# <p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
|
5438
6178
|
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
|
5439
6179
|
# @param [Hash] opts the optional parameters
|
|
5440
6180
|
# @return [EarningsCallTranscripts]
|
|
@@ -5444,7 +6184,7 @@ module FinnhubRuby
|
|
|
5444
6184
|
end
|
|
5445
6185
|
|
|
5446
6186
|
# Earnings Call Transcripts
|
|
5447
|
-
# <p>Get earnings call transcripts, audio and participants' list.
|
|
6187
|
+
# <p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
|
5448
6188
|
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
|
5449
6189
|
# @param [Hash] opts the optional parameters
|
|
5450
6190
|
# @return [Array<(EarningsCallTranscripts, Integer, Hash)>] EarningsCallTranscripts data, response status code and response headers
|