finnhub_ruby 1.1.13 → 1.1.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/BondCandles.md +22 -0
- data/docs/BondProfile.md +58 -0
- data/docs/DefaultApi.md +392 -8
- data/docs/InsiderSentiments.md +20 -0
- data/docs/InsiderSentimentsData.md +26 -0
- data/docs/LobbyingData.md +46 -0
- data/docs/LobbyingResult.md +20 -0
- data/docs/UsaSpending.md +56 -0
- data/docs/UsaSpendingResult.md +20 -0
- data/docs/VisaApplication.md +2 -2
- data/finnhub_ruby-1.1.13.gem +0 -0
- data/finnhub_ruby-1.1.14.gem +0 -0
- data/finnhub_ruby-1.1.15.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +395 -14
- data/lib/finnhub_ruby/models/bond_candles.rb +243 -0
- data/lib/finnhub_ruby/models/bond_profile.rb +419 -0
- data/lib/finnhub_ruby/models/insider_sentiments.rb +231 -0
- data/lib/finnhub_ruby/models/insider_sentiments_data.rb +259 -0
- data/lib/finnhub_ruby/models/lobbying_data.rb +359 -0
- data/lib/finnhub_ruby/models/lobbying_result.rb +231 -0
- data/lib/finnhub_ruby/models/usa_spending.rb +409 -0
- data/lib/finnhub_ruby/models/usa_spending_result.rb +231 -0
- data/lib/finnhub_ruby/models/visa_application.rb +7 -7
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +8 -0
- data/spec/models/bond_candles_spec.rb +46 -0
- data/spec/models/bond_profile_spec.rb +154 -0
- data/spec/models/insider_sentiments_data_spec.rb +58 -0
- data/spec/models/insider_sentiments_spec.rb +40 -0
- data/spec/models/lobbying_data_spec.rb +118 -0
- data/spec/models/lobbying_result_spec.rb +40 -0
- data/spec/models/usa_spending_result_spec.rb +40 -0
- data/spec/models/usa_spending_spec.rb +148 -0
- metadata +37 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e7bac941b8f3c132c056f81150cdf4df5c9a090516deb7d9c8c3f2f0f0d7531
|
4
|
+
data.tar.gz: 7902eb891dfa9aa9a8a3c8ebe301f4b2703ed5175aefde9caeead3fbad2a6ea3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bee858deb0f608f67b7c59e97fed2412d4e7dac705e6b11260c03b09a952ae095442f723f796de3dece6ecbb2a25da8abca7708289c5820fa8689d3bc9d5debf
|
7
|
+
data.tar.gz: ea7a78b43a3c1ef3313367ac53f62d43d1e2b3ebe250fbacb8553a241c8dc2582f85e8a117fb0d9edf1a0699ef62104ebc45ed7c1386f8fd3aeeaf76cd5a55e5
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# finnhub-ruby
|
2
2
|
- API documentation: https://finnhub.io/docs/api
|
3
3
|
- API version: 1.0.0
|
4
|
-
- Package version: 1.1.
|
4
|
+
- Package version: 1.1.16
|
5
5
|
|
6
6
|
## Installation
|
7
7
|
https://rubygems.org/gems/finnhub_ruby
|
@@ -13,7 +13,7 @@ gem install finnhub_ruby
|
|
13
13
|
or in your Gemfile
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
gem 'finnhub_ruby', '~> 1.1.
|
16
|
+
gem 'finnhub_ruby', '~> 1.1.16'
|
17
17
|
```
|
18
18
|
|
19
19
|
## Getting Started
|
data/docs/BondCandles.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# FinnhubRuby::BondCandles
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **c** | **Array<Float>** | List of close prices for returned candles. | [optional] |
|
8
|
+
| **t** | **Array<Integer>** | List of timestamp for returned candles. | [optional] |
|
9
|
+
| **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'finnhub_ruby'
|
15
|
+
|
16
|
+
instance = FinnhubRuby::BondCandles.new(
|
17
|
+
c: null,
|
18
|
+
t: null,
|
19
|
+
s: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/BondProfile.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# FinnhubRuby::BondProfile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **isin** | **String** | ISIN. | [optional] |
|
8
|
+
| **cusip** | **String** | Cusip. | [optional] |
|
9
|
+
| **figi** | **String** | FIGI. | [optional] |
|
10
|
+
| **coupon** | **Float** | Coupon. | [optional] |
|
11
|
+
| **maturity_date** | **String** | Period. | [optional] |
|
12
|
+
| **offering_price** | **Float** | Offering price. | [optional] |
|
13
|
+
| **issue_date** | **String** | Issue date. | [optional] |
|
14
|
+
| **bond_type** | **String** | Bond type. | [optional] |
|
15
|
+
| **debt_type** | **String** | Bond type. | [optional] |
|
16
|
+
| **industry_group** | **String** | Industry. | [optional] |
|
17
|
+
| **industry_sub_group** | **String** | Sub-Industry. | [optional] |
|
18
|
+
| **asset** | **String** | Asset. | [optional] |
|
19
|
+
| **asset_type** | **String** | Asset. | [optional] |
|
20
|
+
| **dated_date** | **String** | Dated date. | [optional] |
|
21
|
+
| **first_coupon_date** | **String** | First coupon date. | [optional] |
|
22
|
+
| **original_offering** | **Float** | Offering amount. | [optional] |
|
23
|
+
| **amount_outstanding** | **Float** | Outstanding amount. | [optional] |
|
24
|
+
| **payment_frequency** | **String** | Payment frequency. | [optional] |
|
25
|
+
| **security_level** | **String** | Security level. | [optional] |
|
26
|
+
| **callable** | **Boolean** | Callable. | [optional] |
|
27
|
+
| **coupon_type** | **String** | Coupon type. | [optional] |
|
28
|
+
|
29
|
+
## Example
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'finnhub_ruby'
|
33
|
+
|
34
|
+
instance = FinnhubRuby::BondProfile.new(
|
35
|
+
isin: null,
|
36
|
+
cusip: null,
|
37
|
+
figi: null,
|
38
|
+
coupon: null,
|
39
|
+
maturity_date: null,
|
40
|
+
offering_price: null,
|
41
|
+
issue_date: null,
|
42
|
+
bond_type: null,
|
43
|
+
debt_type: null,
|
44
|
+
industry_group: null,
|
45
|
+
industry_sub_group: null,
|
46
|
+
asset: null,
|
47
|
+
asset_type: null,
|
48
|
+
dated_date: null,
|
49
|
+
first_coupon_date: null,
|
50
|
+
original_offering: null,
|
51
|
+
amount_outstanding: null,
|
52
|
+
payment_frequency: null,
|
53
|
+
security_level: null,
|
54
|
+
callable: null,
|
55
|
+
coupon_type: null
|
56
|
+
)
|
57
|
+
```
|
58
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -5,6 +5,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
|
8
|
+
| [**bond_price**](DefaultApi.md#bond_price) | **GET** /bond/price | Bond price data |
|
9
|
+
| [**bond_profile**](DefaultApi.md#bond_profile) | **GET** /bond/profile | Bond Profile |
|
8
10
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
9
11
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
10
12
|
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
@@ -44,6 +46,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
44
46
|
| [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership |
|
45
47
|
| [**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents |
|
46
48
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
49
|
+
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
47
50
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
48
51
|
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
49
52
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
@@ -67,10 +70,12 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
67
70
|
| [**stock_bidask**](DefaultApi.md#stock_bidask) | **GET** /stock/bidask | Last Bid-Ask |
|
68
71
|
| [**stock_candles**](DefaultApi.md#stock_candles) | **GET** /stock/candle | Stock Candles |
|
69
72
|
| [**stock_dividends**](DefaultApi.md#stock_dividends) | **GET** /stock/dividend | Dividends |
|
73
|
+
| [**stock_lobbying**](DefaultApi.md#stock_lobbying) | **GET** /stock/lobbying | Senate Lobbying |
|
70
74
|
| [**stock_nbbo**](DefaultApi.md#stock_nbbo) | **GET** /stock/bbo | Historical NBBO |
|
71
75
|
| [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
|
72
76
|
| [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
|
73
77
|
| [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
|
78
|
+
| [**stock_usa_spending**](DefaultApi.md#stock_usa_spending) | **GET** /stock/usa-spending | USA Spending |
|
74
79
|
| [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
|
75
80
|
| [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
|
76
81
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
@@ -155,6 +160,158 @@ end
|
|
155
160
|
- **Accept**: application/json
|
156
161
|
|
157
162
|
|
163
|
+
## bond_price
|
164
|
+
|
165
|
+
> <BondCandles> bond_price(isin, from, to)
|
166
|
+
|
167
|
+
Bond price data
|
168
|
+
|
169
|
+
Get end-of-day bond's price data.
|
170
|
+
|
171
|
+
### Examples
|
172
|
+
|
173
|
+
```ruby
|
174
|
+
require 'time'
|
175
|
+
require 'finnhub_ruby'
|
176
|
+
# setup authorization
|
177
|
+
FinnhubRuby.configure do |config|
|
178
|
+
# Configure API key authorization: api_key
|
179
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
180
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
181
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
182
|
+
end
|
183
|
+
|
184
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
185
|
+
isin = 'isin_example' # String | ISIN.
|
186
|
+
from = 789 # Integer | UNIX timestamp. Interval initial value.
|
187
|
+
to = 789 # Integer | UNIX timestamp. Interval end value.
|
188
|
+
|
189
|
+
begin
|
190
|
+
# Bond price data
|
191
|
+
result = api_instance.bond_price(isin, from, to)
|
192
|
+
p result
|
193
|
+
rescue FinnhubRuby::ApiError => e
|
194
|
+
puts "Error when calling DefaultApi->bond_price: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
#### Using the bond_price_with_http_info variant
|
199
|
+
|
200
|
+
This returns an Array which contains the response data, status code and headers.
|
201
|
+
|
202
|
+
> <Array(<BondCandles>, Integer, Hash)> bond_price_with_http_info(isin, from, to)
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
begin
|
206
|
+
# Bond price data
|
207
|
+
data, status_code, headers = api_instance.bond_price_with_http_info(isin, from, to)
|
208
|
+
p status_code # => 2xx
|
209
|
+
p headers # => { ... }
|
210
|
+
p data # => <BondCandles>
|
211
|
+
rescue FinnhubRuby::ApiError => e
|
212
|
+
puts "Error when calling DefaultApi->bond_price_with_http_info: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
| Name | Type | Description | Notes |
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
220
|
+
| **isin** | **String** | ISIN. | |
|
221
|
+
| **from** | **Integer** | UNIX timestamp. Interval initial value. | |
|
222
|
+
| **to** | **Integer** | UNIX timestamp. Interval end value. | |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
[**BondCandles**](BondCandles.md)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
[api_key](../README.md#api_key)
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: Not defined
|
235
|
+
- **Accept**: application/json
|
236
|
+
|
237
|
+
|
238
|
+
## bond_profile
|
239
|
+
|
240
|
+
> <BondProfile> bond_profile(opts)
|
241
|
+
|
242
|
+
Bond Profile
|
243
|
+
|
244
|
+
Get general information of a bond. You can query by FIGI, ISIN or CUSIP
|
245
|
+
|
246
|
+
### Examples
|
247
|
+
|
248
|
+
```ruby
|
249
|
+
require 'time'
|
250
|
+
require 'finnhub_ruby'
|
251
|
+
# setup authorization
|
252
|
+
FinnhubRuby.configure do |config|
|
253
|
+
# Configure API key authorization: api_key
|
254
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
255
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
256
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
257
|
+
end
|
258
|
+
|
259
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
260
|
+
opts = {
|
261
|
+
isin: 'isin_example', # String | ISIN
|
262
|
+
cusip: 'cusip_example', # String | CUSIP
|
263
|
+
figi: 'figi_example' # String | FIGI
|
264
|
+
}
|
265
|
+
|
266
|
+
begin
|
267
|
+
# Bond Profile
|
268
|
+
result = api_instance.bond_profile(opts)
|
269
|
+
p result
|
270
|
+
rescue FinnhubRuby::ApiError => e
|
271
|
+
puts "Error when calling DefaultApi->bond_profile: #{e}"
|
272
|
+
end
|
273
|
+
```
|
274
|
+
|
275
|
+
#### Using the bond_profile_with_http_info variant
|
276
|
+
|
277
|
+
This returns an Array which contains the response data, status code and headers.
|
278
|
+
|
279
|
+
> <Array(<BondProfile>, Integer, Hash)> bond_profile_with_http_info(opts)
|
280
|
+
|
281
|
+
```ruby
|
282
|
+
begin
|
283
|
+
# Bond Profile
|
284
|
+
data, status_code, headers = api_instance.bond_profile_with_http_info(opts)
|
285
|
+
p status_code # => 2xx
|
286
|
+
p headers # => { ... }
|
287
|
+
p data # => <BondProfile>
|
288
|
+
rescue FinnhubRuby::ApiError => e
|
289
|
+
puts "Error when calling DefaultApi->bond_profile_with_http_info: #{e}"
|
290
|
+
end
|
291
|
+
```
|
292
|
+
|
293
|
+
### Parameters
|
294
|
+
|
295
|
+
| Name | Type | Description | Notes |
|
296
|
+
| ---- | ---- | ----------- | ----- |
|
297
|
+
| **isin** | **String** | ISIN | [optional] |
|
298
|
+
| **cusip** | **String** | CUSIP | [optional] |
|
299
|
+
| **figi** | **String** | FIGI | [optional] |
|
300
|
+
|
301
|
+
### Return type
|
302
|
+
|
303
|
+
[**BondProfile**](BondProfile.md)
|
304
|
+
|
305
|
+
### Authorization
|
306
|
+
|
307
|
+
[api_key](../README.md#api_key)
|
308
|
+
|
309
|
+
### HTTP request headers
|
310
|
+
|
311
|
+
- **Content-Type**: Not defined
|
312
|
+
- **Accept**: application/json
|
313
|
+
|
314
|
+
|
158
315
|
## company_basic_financials
|
159
316
|
|
160
317
|
> <BasicFinancials> company_basic_financials(symbol, metric)
|
@@ -1930,7 +2087,8 @@ api_instance = FinnhubRuby::DefaultApi.new
|
|
1930
2087
|
opts = {
|
1931
2088
|
symbol: 'symbol_example', # String | ETF symbol.
|
1932
2089
|
isin: 'isin_example', # String | ETF isin.
|
1933
|
-
skip: 789 # Integer | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
2090
|
+
skip: 789, # Integer | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
2091
|
+
date: 'date_example' # String | Query holdings by date. You can use either this param or <code>skip</code> param, not both.
|
1934
2092
|
}
|
1935
2093
|
|
1936
2094
|
begin
|
@@ -1967,6 +2125,7 @@ end
|
|
1967
2125
|
| **symbol** | **String** | ETF symbol. | [optional] |
|
1968
2126
|
| **isin** | **String** | ETF isin. | [optional] |
|
1969
2127
|
| **skip** | **Integer** | Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set. | [optional] |
|
2128
|
+
| **date** | **String** | Query holdings by date. You can use either this param or <code>skip</code> param, not both. | [optional] |
|
1970
2129
|
|
1971
2130
|
### Return type
|
1972
2131
|
|
@@ -2947,7 +3106,7 @@ end
|
|
2947
3106
|
|
2948
3107
|
Indices Historical Constituents
|
2949
3108
|
|
2950
|
-
Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC
|
3109
|
+
Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>
|
2951
3110
|
|
2952
3111
|
### Examples
|
2953
3112
|
|
@@ -3012,6 +3171,81 @@ end
|
|
3012
3171
|
- **Accept**: application/json
|
3013
3172
|
|
3014
3173
|
|
3174
|
+
## insider_sentiment
|
3175
|
+
|
3176
|
+
> <InsiderSentiments> insider_sentiment(symbol, from, to)
|
3177
|
+
|
3178
|
+
Insider Sentiment
|
3179
|
+
|
3180
|
+
Get insider sentiment data for US companies calculated using method discussed <a href=\"https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a\" target=\"_blank\">here</a>. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.
|
3181
|
+
|
3182
|
+
### Examples
|
3183
|
+
|
3184
|
+
```ruby
|
3185
|
+
require 'time'
|
3186
|
+
require 'finnhub_ruby'
|
3187
|
+
# setup authorization
|
3188
|
+
FinnhubRuby.configure do |config|
|
3189
|
+
# Configure API key authorization: api_key
|
3190
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3192
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3193
|
+
end
|
3194
|
+
|
3195
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3196
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
3197
|
+
from = Date.parse('2013-10-20') # Date | From date: 2020-03-15.
|
3198
|
+
to = Date.parse('2013-10-20') # Date | To date: 2020-03-16.
|
3199
|
+
|
3200
|
+
begin
|
3201
|
+
# Insider Sentiment
|
3202
|
+
result = api_instance.insider_sentiment(symbol, from, to)
|
3203
|
+
p result
|
3204
|
+
rescue FinnhubRuby::ApiError => e
|
3205
|
+
puts "Error when calling DefaultApi->insider_sentiment: #{e}"
|
3206
|
+
end
|
3207
|
+
```
|
3208
|
+
|
3209
|
+
#### Using the insider_sentiment_with_http_info variant
|
3210
|
+
|
3211
|
+
This returns an Array which contains the response data, status code and headers.
|
3212
|
+
|
3213
|
+
> <Array(<InsiderSentiments>, Integer, Hash)> insider_sentiment_with_http_info(symbol, from, to)
|
3214
|
+
|
3215
|
+
```ruby
|
3216
|
+
begin
|
3217
|
+
# Insider Sentiment
|
3218
|
+
data, status_code, headers = api_instance.insider_sentiment_with_http_info(symbol, from, to)
|
3219
|
+
p status_code # => 2xx
|
3220
|
+
p headers # => { ... }
|
3221
|
+
p data # => <InsiderSentiments>
|
3222
|
+
rescue FinnhubRuby::ApiError => e
|
3223
|
+
puts "Error when calling DefaultApi->insider_sentiment_with_http_info: #{e}"
|
3224
|
+
end
|
3225
|
+
```
|
3226
|
+
|
3227
|
+
### Parameters
|
3228
|
+
|
3229
|
+
| Name | Type | Description | Notes |
|
3230
|
+
| ---- | ---- | ----------- | ----- |
|
3231
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
3232
|
+
| **from** | **Date** | From date: 2020-03-15. | |
|
3233
|
+
| **to** | **Date** | To date: 2020-03-16. | |
|
3234
|
+
|
3235
|
+
### Return type
|
3236
|
+
|
3237
|
+
[**InsiderSentiments**](InsiderSentiments.md)
|
3238
|
+
|
3239
|
+
### Authorization
|
3240
|
+
|
3241
|
+
[api_key](../README.md#api_key)
|
3242
|
+
|
3243
|
+
### HTTP request headers
|
3244
|
+
|
3245
|
+
- **Content-Type**: Not defined
|
3246
|
+
- **Accept**: application/json
|
3247
|
+
|
3248
|
+
|
3015
3249
|
## insider_transactions
|
3016
3250
|
|
3017
3251
|
> <InsiderTransactions> insider_transactions(symbol, opts)
|
@@ -3460,7 +3694,7 @@ end
|
|
3460
3694
|
|
3461
3695
|
Mutual Funds Holdings
|
3462
3696
|
|
3463
|
-
Get full Mutual Funds holdings/constituents.
|
3697
|
+
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.
|
3464
3698
|
|
3465
3699
|
### Examples
|
3466
3700
|
|
@@ -3537,7 +3771,7 @@ end
|
|
3537
3771
|
|
3538
3772
|
Mutual Funds Profile
|
3539
3773
|
|
3540
|
-
Get mutual funds profile information. This endpoint covers US mutual funds
|
3774
|
+
Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
3541
3775
|
|
3542
3776
|
### Examples
|
3543
3777
|
|
@@ -4709,6 +4943,81 @@ end
|
|
4709
4943
|
- **Accept**: application/json
|
4710
4944
|
|
4711
4945
|
|
4946
|
+
## stock_lobbying
|
4947
|
+
|
4948
|
+
> <LobbyingResult> stock_lobbying(symbol, from, to)
|
4949
|
+
|
4950
|
+
Senate Lobbying
|
4951
|
+
|
4952
|
+
Get a list of reported lobbying activities in the Senate and the House.
|
4953
|
+
|
4954
|
+
### Examples
|
4955
|
+
|
4956
|
+
```ruby
|
4957
|
+
require 'time'
|
4958
|
+
require 'finnhub_ruby'
|
4959
|
+
# setup authorization
|
4960
|
+
FinnhubRuby.configure do |config|
|
4961
|
+
# Configure API key authorization: api_key
|
4962
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4963
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4964
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4965
|
+
end
|
4966
|
+
|
4967
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4968
|
+
symbol = 'symbol_example' # String | Symbol.
|
4969
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
4970
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
4971
|
+
|
4972
|
+
begin
|
4973
|
+
# Senate Lobbying
|
4974
|
+
result = api_instance.stock_lobbying(symbol, from, to)
|
4975
|
+
p result
|
4976
|
+
rescue FinnhubRuby::ApiError => e
|
4977
|
+
puts "Error when calling DefaultApi->stock_lobbying: #{e}"
|
4978
|
+
end
|
4979
|
+
```
|
4980
|
+
|
4981
|
+
#### Using the stock_lobbying_with_http_info variant
|
4982
|
+
|
4983
|
+
This returns an Array which contains the response data, status code and headers.
|
4984
|
+
|
4985
|
+
> <Array(<LobbyingResult>, Integer, Hash)> stock_lobbying_with_http_info(symbol, from, to)
|
4986
|
+
|
4987
|
+
```ruby
|
4988
|
+
begin
|
4989
|
+
# Senate Lobbying
|
4990
|
+
data, status_code, headers = api_instance.stock_lobbying_with_http_info(symbol, from, to)
|
4991
|
+
p status_code # => 2xx
|
4992
|
+
p headers # => { ... }
|
4993
|
+
p data # => <LobbyingResult>
|
4994
|
+
rescue FinnhubRuby::ApiError => e
|
4995
|
+
puts "Error when calling DefaultApi->stock_lobbying_with_http_info: #{e}"
|
4996
|
+
end
|
4997
|
+
```
|
4998
|
+
|
4999
|
+
### Parameters
|
5000
|
+
|
5001
|
+
| Name | Type | Description | Notes |
|
5002
|
+
| ---- | ---- | ----------- | ----- |
|
5003
|
+
| **symbol** | **String** | Symbol. | |
|
5004
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
5005
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
5006
|
+
|
5007
|
+
### Return type
|
5008
|
+
|
5009
|
+
[**LobbyingResult**](LobbyingResult.md)
|
5010
|
+
|
5011
|
+
### Authorization
|
5012
|
+
|
5013
|
+
[api_key](../README.md#api_key)
|
5014
|
+
|
5015
|
+
### HTTP request headers
|
5016
|
+
|
5017
|
+
- **Content-Type**: Not defined
|
5018
|
+
- **Accept**: application/json
|
5019
|
+
|
5020
|
+
|
4712
5021
|
## stock_nbbo
|
4713
5022
|
|
4714
5023
|
> <HistoricalNBBO> stock_nbbo(symbol, date, limit, skip)
|
@@ -4867,7 +5176,7 @@ end
|
|
4867
5176
|
|
4868
5177
|
Stock Symbol
|
4869
5178
|
|
4870
|
-
List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
|
5179
|
+
List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
|
4871
5180
|
|
4872
5181
|
### Examples
|
4873
5182
|
|
@@ -4946,7 +5255,7 @@ end
|
|
4946
5255
|
|
4947
5256
|
Tick Data
|
4948
5257
|
|
4949
|
-
<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr>
|
5258
|
+
<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
4950
5259
|
|
4951
5260
|
### Examples
|
4952
5261
|
|
@@ -5017,6 +5326,81 @@ end
|
|
5017
5326
|
- **Accept**: application/json
|
5018
5327
|
|
5019
5328
|
|
5329
|
+
## stock_usa_spending
|
5330
|
+
|
5331
|
+
> <UsaSpendingResult> stock_usa_spending(symbol, from, to)
|
5332
|
+
|
5333
|
+
USA Spending
|
5334
|
+
|
5335
|
+
Get a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.
|
5336
|
+
|
5337
|
+
### Examples
|
5338
|
+
|
5339
|
+
```ruby
|
5340
|
+
require 'time'
|
5341
|
+
require 'finnhub_ruby'
|
5342
|
+
# setup authorization
|
5343
|
+
FinnhubRuby.configure do |config|
|
5344
|
+
# Configure API key authorization: api_key
|
5345
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5346
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5347
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5348
|
+
end
|
5349
|
+
|
5350
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5351
|
+
symbol = 'symbol_example' # String | Symbol.
|
5352
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
|
5353
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
|
5354
|
+
|
5355
|
+
begin
|
5356
|
+
# USA Spending
|
5357
|
+
result = api_instance.stock_usa_spending(symbol, from, to)
|
5358
|
+
p result
|
5359
|
+
rescue FinnhubRuby::ApiError => e
|
5360
|
+
puts "Error when calling DefaultApi->stock_usa_spending: #{e}"
|
5361
|
+
end
|
5362
|
+
```
|
5363
|
+
|
5364
|
+
#### Using the stock_usa_spending_with_http_info variant
|
5365
|
+
|
5366
|
+
This returns an Array which contains the response data, status code and headers.
|
5367
|
+
|
5368
|
+
> <Array(<UsaSpendingResult>, Integer, Hash)> stock_usa_spending_with_http_info(symbol, from, to)
|
5369
|
+
|
5370
|
+
```ruby
|
5371
|
+
begin
|
5372
|
+
# USA Spending
|
5373
|
+
data, status_code, headers = api_instance.stock_usa_spending_with_http_info(symbol, from, to)
|
5374
|
+
p status_code # => 2xx
|
5375
|
+
p headers # => { ... }
|
5376
|
+
p data # => <UsaSpendingResult>
|
5377
|
+
rescue FinnhubRuby::ApiError => e
|
5378
|
+
puts "Error when calling DefaultApi->stock_usa_spending_with_http_info: #{e}"
|
5379
|
+
end
|
5380
|
+
```
|
5381
|
+
|
5382
|
+
### Parameters
|
5383
|
+
|
5384
|
+
| Name | Type | Description | Notes |
|
5385
|
+
| ---- | ---- | ----------- | ----- |
|
5386
|
+
| **symbol** | **String** | Symbol. | |
|
5387
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code> | |
|
5388
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code> | |
|
5389
|
+
|
5390
|
+
### Return type
|
5391
|
+
|
5392
|
+
[**UsaSpendingResult**](UsaSpendingResult.md)
|
5393
|
+
|
5394
|
+
### Authorization
|
5395
|
+
|
5396
|
+
[api_key](../README.md#api_key)
|
5397
|
+
|
5398
|
+
### HTTP request headers
|
5399
|
+
|
5400
|
+
- **Content-Type**: Not defined
|
5401
|
+
- **Accept**: application/json
|
5402
|
+
|
5403
|
+
|
5020
5404
|
## stock_uspto_patent
|
5021
5405
|
|
5022
5406
|
> <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
|
@@ -5173,7 +5557,7 @@ end
|
|
5173
5557
|
|
5174
5558
|
Supply Chain Relationships
|
5175
5559
|
|
5176
|
-
<p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p
|
5560
|
+
<p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p>
|
5177
5561
|
|
5178
5562
|
### Examples
|
5179
5563
|
|
@@ -5542,7 +5926,7 @@ end
|
|
5542
5926
|
|
5543
5927
|
Earnings Call Transcripts List
|
5544
5928
|
|
5545
|
-
List earnings call transcripts' metadata. This endpoint is available for US, UK and Canadian companies.
|
5929
|
+
List earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.
|
5546
5930
|
|
5547
5931
|
### Examples
|
5548
5932
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::InsiderSentiments
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
+
| **data** | [**Array<InsiderSentimentsData>**](InsiderSentimentsData.md) | Array of sentiment data. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::InsiderSentiments.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::InsiderSentimentsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **year** | **Integer** | Year. | [optional] |
|
9
|
+
| **month** | **Integer** | Month. | [optional] |
|
10
|
+
| **change** | **Integer** | Net buying/selling from all insiders' transactions. | [optional] |
|
11
|
+
| **mspr** | **Float** | Monthly share purchase ratio. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::InsiderSentimentsData.new(
|
19
|
+
symbol: null,
|
20
|
+
year: null,
|
21
|
+
month: null,
|
22
|
+
change: null,
|
23
|
+
mspr: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|