finnhub_ruby 1.1.18 → 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 +6 -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 +312 -92
- data/docs/Dividends.md +3 -1
- data/docs/DocumentResponse.md +28 -0
- data/docs/ETFHoldingsData.md +3 -1
- 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/MutualFundEet.md +20 -0
- data/docs/MutualFundEetPai.md +20 -0
- data/docs/MutualFundHoldingsData.md +3 -1
- data/docs/PriceMetrics.md +2 -0
- data/docs/SearchBody.md +60 -0
- data/docs/SearchFilter.md +20 -0
- data/docs/SearchResponse.md +24 -0
- data/finnhub_ruby-1.1.18.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +296 -86
- data/lib/finnhub_ruby/models/bond_tick_data.rb +37 -1
- 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/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/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 +11 -1
- 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/version.rb +1 -1
- data/lib/finnhub_ruby.rb +14 -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/mutual_fund_eet_pai_spec.rb +40 -0
- data/spec/models/mutual_fund_eet_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
- metadata +60 -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
|
@@ -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
|
@@ -326,6 +326,70 @@ module FinnhubRuby
|
|
326
326
|
return data, status_code, headers
|
327
327
|
end
|
328
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
|
+
|
329
393
|
# Basic Financials
|
330
394
|
# Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
|
331
395
|
# @param symbol [String] Symbol of the company: AAPL.
|
@@ -1208,6 +1272,84 @@ module FinnhubRuby
|
|
1208
1272
|
return data, status_code, headers
|
1209
1273
|
end
|
1210
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
|
+
|
1211
1353
|
# Country Metadata
|
1212
1354
|
# List all countries and metadata.
|
1213
1355
|
# @param [Hash] opts the optional parameters
|
@@ -1910,7 +2052,7 @@ module FinnhubRuby
|
|
1910
2052
|
end
|
1911
2053
|
|
1912
2054
|
# ETFs Holdings
|
1913
|
-
# 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>.
|
1914
2056
|
# @param [Hash] opts the optional parameters
|
1915
2057
|
# @option opts [String] :symbol ETF symbol.
|
1916
2058
|
# @option opts [String] :isin ETF isin.
|
@@ -1923,7 +2065,7 @@ module FinnhubRuby
|
|
1923
2065
|
end
|
1924
2066
|
|
1925
2067
|
# ETFs Holdings
|
1926
|
-
# 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>.
|
1927
2069
|
# @param [Hash] opts the optional parameters
|
1928
2070
|
# @option opts [String] :symbol ETF symbol.
|
1929
2071
|
# @option opts [String] :isin ETF isin.
|
@@ -1979,7 +2121,7 @@ module FinnhubRuby
|
|
1979
2121
|
end
|
1980
2122
|
|
1981
2123
|
# ETFs Profile
|
1982
|
-
# 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>.
|
1983
2125
|
# @param [Hash] opts the optional parameters
|
1984
2126
|
# @option opts [String] :symbol ETF symbol.
|
1985
2127
|
# @option opts [String] :isin ETF isin.
|
@@ -1990,7 +2132,7 @@ module FinnhubRuby
|
|
1990
2132
|
end
|
1991
2133
|
|
1992
2134
|
# ETFs Profile
|
1993
|
-
# 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>.
|
1994
2136
|
# @param [Hash] opts the optional parameters
|
1995
2137
|
# @option opts [String] :symbol ETF symbol.
|
1996
2138
|
# @option opts [String] :isin ETF isin.
|
@@ -2997,7 +3139,7 @@ module FinnhubRuby
|
|
2997
3139
|
end
|
2998
3140
|
|
2999
3141
|
# Insider Transactions
|
3000
|
-
# 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.
|
3001
3143
|
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
3002
3144
|
# @param [Hash] opts the optional parameters
|
3003
3145
|
# @option opts [Date] :from From date: 2020-03-15.
|
@@ -3009,7 +3151,7 @@ module FinnhubRuby
|
|
3009
3151
|
end
|
3010
3152
|
|
3011
3153
|
# Insider Transactions
|
3012
|
-
# 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.
|
3013
3155
|
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
3014
3156
|
# @param [Hash] opts the optional parameters
|
3015
3157
|
# @option opts [Date] :from From date: 2020-03-15.
|
@@ -3152,7 +3294,7 @@ module FinnhubRuby
|
|
3152
3294
|
end
|
3153
3295
|
|
3154
3296
|
# Institutional Portfolio
|
3155
|
-
# Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time.
|
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>.
|
3156
3298
|
# @param cik [String] Fund's CIK.
|
3157
3299
|
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
3158
3300
|
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
@@ -3164,7 +3306,7 @@ module FinnhubRuby
|
|
3164
3306
|
end
|
3165
3307
|
|
3166
3308
|
# Institutional Portfolio
|
3167
|
-
# Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time.
|
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>.
|
3168
3310
|
# @param cik [String] Fund's CIK.
|
3169
3311
|
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
3170
3312
|
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
@@ -3289,69 +3431,6 @@ module FinnhubRuby
|
|
3289
3431
|
return data, status_code, headers
|
3290
3432
|
end
|
3291
3433
|
|
3292
|
-
# International Filings
|
3293
|
-
# List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage. Enterprise clients who need access to the full filings for global markets should contact us for the access.
|
3294
|
-
# @param [Hash] opts the optional parameters
|
3295
|
-
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
3296
|
-
# @option opts [String] :country Filter by country using country's 2-letter code.
|
3297
|
-
# @return [Array<InternationalFiling>]
|
3298
|
-
def international_filings(opts = {})
|
3299
|
-
data, _status_code, _headers = international_filings_with_http_info(opts)
|
3300
|
-
data
|
3301
|
-
end
|
3302
|
-
|
3303
|
-
# International Filings
|
3304
|
-
# List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage. Enterprise clients who need access to the full filings for global markets should contact us for the access.
|
3305
|
-
# @param [Hash] opts the optional parameters
|
3306
|
-
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
3307
|
-
# @option opts [String] :country Filter by country using country's 2-letter code.
|
3308
|
-
# @return [Array<(Array<InternationalFiling>, Integer, Hash)>] Array<InternationalFiling> data, response status code and response headers
|
3309
|
-
def international_filings_with_http_info(opts = {})
|
3310
|
-
if @api_client.config.debugging
|
3311
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.international_filings ...'
|
3312
|
-
end
|
3313
|
-
# resource path
|
3314
|
-
local_var_path = '/stock/international-filings'
|
3315
|
-
|
3316
|
-
# query parameters
|
3317
|
-
query_params = opts[:query_params] || {}
|
3318
|
-
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
3319
|
-
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
3320
|
-
|
3321
|
-
# header parameters
|
3322
|
-
header_params = opts[:header_params] || {}
|
3323
|
-
# HTTP header 'Accept' (if needed)
|
3324
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3325
|
-
|
3326
|
-
# form parameters
|
3327
|
-
form_params = opts[:form_params] || {}
|
3328
|
-
|
3329
|
-
# http body (model)
|
3330
|
-
post_body = opts[:debug_body]
|
3331
|
-
|
3332
|
-
# return_type
|
3333
|
-
return_type = opts[:debug_return_type] || 'Array<InternationalFiling>'
|
3334
|
-
|
3335
|
-
# auth_names
|
3336
|
-
auth_names = opts[:debug_auth_names] || ['api_key']
|
3337
|
-
|
3338
|
-
new_options = opts.merge(
|
3339
|
-
:operation => :"DefaultApi.international_filings",
|
3340
|
-
:header_params => header_params,
|
3341
|
-
:query_params => query_params,
|
3342
|
-
:form_params => form_params,
|
3343
|
-
:body => post_body,
|
3344
|
-
:auth_names => auth_names,
|
3345
|
-
:return_type => return_type
|
3346
|
-
)
|
3347
|
-
|
3348
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3349
|
-
if @api_client.config.debugging
|
3350
|
-
@api_client.config.logger.debug "API called: DefaultApi#international_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3351
|
-
end
|
3352
|
-
return data, status_code, headers
|
3353
|
-
end
|
3354
|
-
|
3355
3434
|
# Investment Themes (Thematic Investing)
|
3356
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>
|
3357
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>.
|
@@ -3689,8 +3768,136 @@ module FinnhubRuby
|
|
3689
3768
|
return data, status_code, headers
|
3690
3769
|
end
|
3691
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
|
+
|
3692
3899
|
# Mutual Funds Holdings
|
3693
|
-
# 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>.
|
3694
3901
|
# @param [Hash] opts the optional parameters
|
3695
3902
|
# @option opts [String] :symbol Fund's symbol.
|
3696
3903
|
# @option opts [String] :isin Fund's isin.
|
@@ -3702,7 +3909,7 @@ module FinnhubRuby
|
|
3702
3909
|
end
|
3703
3910
|
|
3704
3911
|
# Mutual Funds Holdings
|
3705
|
-
# 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>.
|
3706
3913
|
# @param [Hash] opts the optional parameters
|
3707
3914
|
# @option opts [String] :symbol Fund's symbol.
|
3708
3915
|
# @option opts [String] :isin Fund's isin.
|
@@ -3756,7 +3963,7 @@ module FinnhubRuby
|
|
3756
3963
|
end
|
3757
3964
|
|
3758
3965
|
# Mutual Funds Profile
|
3759
|
-
# 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>.
|
3760
3967
|
# @param [Hash] opts the optional parameters
|
3761
3968
|
# @option opts [String] :symbol Fund's symbol.
|
3762
3969
|
# @option opts [String] :isin Fund's isin.
|
@@ -3767,7 +3974,7 @@ module FinnhubRuby
|
|
3767
3974
|
end
|
3768
3975
|
|
3769
3976
|
# Mutual Funds Profile
|
3770
|
-
# 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>.
|
3771
3978
|
# @param [Hash] opts the optional parameters
|
3772
3979
|
# @option opts [String] :symbol Fund's symbol.
|
3773
3980
|
# @option opts [String] :isin Fund's isin.
|
@@ -4158,6 +4365,7 @@ module FinnhubRuby
|
|
4158
4365
|
# Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
4159
4366
|
# @param symbol [String] Symbol of the company: AAPL.
|
4160
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.
|
4161
4369
|
# @return [PriceMetrics]
|
4162
4370
|
def price_metrics(symbol, opts = {})
|
4163
4371
|
data, _status_code, _headers = price_metrics_with_http_info(symbol, opts)
|
@@ -4168,6 +4376,7 @@ module FinnhubRuby
|
|
4168
4376
|
# Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
4169
4377
|
# @param symbol [String] Symbol of the company: AAPL.
|
4170
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.
|
4171
4380
|
# @return [Array<(PriceMetrics, Integer, Hash)>] PriceMetrics data, response status code and response headers
|
4172
4381
|
def price_metrics_with_http_info(symbol, opts = {})
|
4173
4382
|
if @api_client.config.debugging
|
@@ -4183,6 +4392,7 @@ module FinnhubRuby
|
|
4183
4392
|
# query parameters
|
4184
4393
|
query_params = opts[:query_params] || {}
|
4185
4394
|
query_params[:'symbol'] = symbol
|
4395
|
+
query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
|
4186
4396
|
|
4187
4397
|
# header parameters
|
4188
4398
|
header_params = opts[:header_params] || {}
|
@@ -5279,7 +5489,7 @@ module FinnhubRuby
|
|
5279
5489
|
end
|
5280
5490
|
|
5281
5491
|
# Tick Data
|
5282
|
-
# <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>
|
5283
5493
|
# @param symbol [String] Symbol.
|
5284
5494
|
# @param date [Date] Date: 2020-04-02.
|
5285
5495
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -5292,7 +5502,7 @@ module FinnhubRuby
|
|
5292
5502
|
end
|
5293
5503
|
|
5294
5504
|
# Tick Data
|
5295
|
-
# <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>
|
5296
5506
|
# @param symbol [String] Symbol.
|
5297
5507
|
# @param date [Date] Date: 2020-04-02.
|
5298
5508
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -5733,7 +5943,7 @@ module FinnhubRuby
|
|
5733
5943
|
end
|
5734
5944
|
|
5735
5945
|
# Symbol Change
|
5736
|
-
# Get a list of symbol changes for US-listed
|
5946
|
+
# Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
5737
5947
|
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
5738
5948
|
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
5739
5949
|
# @param [Hash] opts the optional parameters
|
@@ -5744,7 +5954,7 @@ module FinnhubRuby
|
|
5744
5954
|
end
|
5745
5955
|
|
5746
5956
|
# Symbol Change
|
5747
|
-
# Get a list of symbol changes for US-listed
|
5957
|
+
# Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
5748
5958
|
# @param from [String] From date <code>YYYY-MM-DD</code>.
|
5749
5959
|
# @param to [String] To date <code>YYYY-MM-DD</code>.
|
5750
5960
|
# @param [Hash] opts the optional parameters
|
@@ -5956,7 +6166,7 @@ module FinnhubRuby
|
|
5956
6166
|
:return_type => return_type
|
5957
6167
|
)
|
5958
6168
|
|
5959
|
-
data, status_code, headers = @api_client.call_api(:
|
6169
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
5960
6170
|
if @api_client.config.debugging
|
5961
6171
|
@api_client.config.logger.debug "API called: DefaultApi#technical_indicator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5962
6172
|
end
|
@@ -5964,7 +6174,7 @@ module FinnhubRuby
|
|
5964
6174
|
end
|
5965
6175
|
|
5966
6176
|
# Earnings Call Transcripts
|
5967
|
-
# <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>
|
5968
6178
|
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
5969
6179
|
# @param [Hash] opts the optional parameters
|
5970
6180
|
# @return [EarningsCallTranscripts]
|
@@ -5974,7 +6184,7 @@ module FinnhubRuby
|
|
5974
6184
|
end
|
5975
6185
|
|
5976
6186
|
# Earnings Call Transcripts
|
5977
|
-
# <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>
|
5978
6188
|
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
5979
6189
|
# @param [Hash] opts the optional parameters
|
5980
6190
|
# @return [Array<(EarningsCallTranscripts, Integer, Hash)>] EarningsCallTranscripts data, response status code and response headers
|