finnhub_ruby 1.1.11 → 1.1.14
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 +9 -3
- data/docs/DefaultApi.md +240 -8
- data/docs/InsiderSentiments.md +20 -0
- data/docs/InsiderSentimentsData.md +26 -0
- data/docs/StockSymbol.md +7 -1
- data/docs/UsptoPatent.md +34 -0
- data/docs/UsptoPatentResult.md +20 -0
- data/docs/VisaApplication.md +62 -0
- data/docs/VisaApplicationResult.md +20 -0
- data/finnhub_ruby-1.1.11.gem +0 -0
- data/finnhub_ruby-1.1.12.gem +0 -0
- data/finnhub_ruby-1.1.13.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +252 -12
- 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/stock_symbol.rb +34 -4
- data/lib/finnhub_ruby/models/uspto_patent.rb +301 -0
- data/lib/finnhub_ruby/models/uspto_patent_result.rb +231 -0
- data/lib/finnhub_ruby/models/visa_application.rb +439 -0
- data/lib/finnhub_ruby/models/visa_application_result.rb +231 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +6 -0
- data/spec/models/insider_sentiments_data_spec.rb +58 -0
- data/spec/models/insider_sentiments_spec.rb +40 -0
- data/spec/models/uspto_patent_result_spec.rb +40 -0
- data/spec/models/uspto_patent_spec.rb +82 -0
- data/spec/models/visa_application_result_spec.rb +40 -0
- data/spec/models/visa_application_spec.rb +166 -0
- metadata +29 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: da30940be0c21631a723ce3fefafb49bf48d79bad357b9a95d6b44124aea729a
|
4
|
+
data.tar.gz: b17728b586b1368112477733e416f0d5d196688a243549255c17fb8ea2a8aaa1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 224c15f4a06ec436c4569f47d2000a13185e52f02bf2763311e00d63523006609fbc09db5f08068c3fa41fcb05c0e7205ba961a9e37fc32f58b6a9f1322e2426
|
7
|
+
data.tar.gz: e1d0cde8725213b7bf9c6b09b17d5ed1768be82c2a8b602038b9f14f2add4f73235170737aeaca4aa0aab0a8c0e0e0d7a7224b0174bbc8ce4a531468a87e338c
|
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.13
|
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.13'
|
17
17
|
```
|
18
18
|
|
19
19
|
## Getting Started
|
@@ -67,7 +67,6 @@ puts(finnhub_client.company_eps_estimates('AMZN', {freq: 'quarterly'}))
|
|
67
67
|
puts(finnhub_client.company_executive('AAPL'))
|
68
68
|
|
69
69
|
# Company News
|
70
|
-
# Need to use _from instead of from to avoid conflict
|
71
70
|
puts(finnhub_client.company_news('AAPL', "2020-06-01", "2020-06-10"))
|
72
71
|
|
73
72
|
# Company Peers
|
@@ -251,6 +250,13 @@ puts(finnhub_client.company_ebitda_estimates('AAPL', {freq: 'quarterly'}))
|
|
251
250
|
|
252
251
|
# EBIT Estimates
|
253
252
|
puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
|
253
|
+
|
254
|
+
# USPTO
|
255
|
+
puts(finnhub_client.stock_uspto_patent('NVDA', "2020-06-01", "2021-06-10"))
|
256
|
+
|
257
|
+
# Visa Application
|
258
|
+
puts(finnhub_client.stock_visa_application('AAPL', "2020-06-01", "2021-06-10"))
|
259
|
+
|
254
260
|
```
|
255
261
|
|
256
262
|
## License
|
data/docs/DefaultApi.md
CHANGED
@@ -44,6 +44,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
44
44
|
| [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership |
|
45
45
|
| [**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents |
|
46
46
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
47
|
+
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
47
48
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
48
49
|
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
49
50
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
@@ -71,6 +72,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
71
72
|
| [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
|
72
73
|
| [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
|
73
74
|
| [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
|
75
|
+
| [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
|
76
|
+
| [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
|
74
77
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
75
78
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
76
79
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
@@ -1928,7 +1931,8 @@ api_instance = FinnhubRuby::DefaultApi.new
|
|
1928
1931
|
opts = {
|
1929
1932
|
symbol: 'symbol_example', # String | ETF symbol.
|
1930
1933
|
isin: 'isin_example', # String | ETF isin.
|
1931
|
-
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.
|
1934
|
+
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.
|
1935
|
+
date: 'date_example' # String | Query holdings by date. You can use either this param or <code>skip</code> param, not both.
|
1932
1936
|
}
|
1933
1937
|
|
1934
1938
|
begin
|
@@ -1965,6 +1969,7 @@ end
|
|
1965
1969
|
| **symbol** | **String** | ETF symbol. | [optional] |
|
1966
1970
|
| **isin** | **String** | ETF isin. | [optional] |
|
1967
1971
|
| **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] |
|
1972
|
+
| **date** | **String** | Query holdings by date. You can use either this param or <code>skip</code> param, not both. | [optional] |
|
1968
1973
|
|
1969
1974
|
### Return type
|
1970
1975
|
|
@@ -2670,7 +2675,8 @@ end
|
|
2670
2675
|
|
2671
2676
|
api_instance = FinnhubRuby::DefaultApi.new
|
2672
2677
|
opts = {
|
2673
|
-
base: 'base_example' # String | Base currency. Default to EUR.
|
2678
|
+
base: 'base_example', # String | Base currency. Default to EUR.
|
2679
|
+
date: 'date_example' # String | Date. Leave blank to get the latest data.
|
2674
2680
|
}
|
2675
2681
|
|
2676
2682
|
begin
|
@@ -2705,6 +2711,7 @@ end
|
|
2705
2711
|
| Name | Type | Description | Notes |
|
2706
2712
|
| ---- | ---- | ----------- | ----- |
|
2707
2713
|
| **base** | **String** | Base currency. Default to EUR. | [optional] |
|
2714
|
+
| **date** | **String** | Date. Leave blank to get the latest data. | [optional] |
|
2708
2715
|
|
2709
2716
|
### Return type
|
2710
2717
|
|
@@ -2943,7 +2950,7 @@ end
|
|
2943
2950
|
|
2944
2951
|
Indices Historical Constituents
|
2945
2952
|
|
2946
|
-
Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC
|
2953
|
+
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>
|
2947
2954
|
|
2948
2955
|
### Examples
|
2949
2956
|
|
@@ -3008,6 +3015,81 @@ end
|
|
3008
3015
|
- **Accept**: application/json
|
3009
3016
|
|
3010
3017
|
|
3018
|
+
## insider_sentiment
|
3019
|
+
|
3020
|
+
> <InsiderSentiments> insider_sentiment(symbol, from, to)
|
3021
|
+
|
3022
|
+
Insider Sentiment
|
3023
|
+
|
3024
|
+
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.
|
3025
|
+
|
3026
|
+
### Examples
|
3027
|
+
|
3028
|
+
```ruby
|
3029
|
+
require 'time'
|
3030
|
+
require 'finnhub_ruby'
|
3031
|
+
# setup authorization
|
3032
|
+
FinnhubRuby.configure do |config|
|
3033
|
+
# Configure API key authorization: api_key
|
3034
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3035
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3036
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3037
|
+
end
|
3038
|
+
|
3039
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3040
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
3041
|
+
from = Date.parse('2013-10-20') # Date | From date: 2020-03-15.
|
3042
|
+
to = Date.parse('2013-10-20') # Date | To date: 2020-03-16.
|
3043
|
+
|
3044
|
+
begin
|
3045
|
+
# Insider Sentiment
|
3046
|
+
result = api_instance.insider_sentiment(symbol, from, to)
|
3047
|
+
p result
|
3048
|
+
rescue FinnhubRuby::ApiError => e
|
3049
|
+
puts "Error when calling DefaultApi->insider_sentiment: #{e}"
|
3050
|
+
end
|
3051
|
+
```
|
3052
|
+
|
3053
|
+
#### Using the insider_sentiment_with_http_info variant
|
3054
|
+
|
3055
|
+
This returns an Array which contains the response data, status code and headers.
|
3056
|
+
|
3057
|
+
> <Array(<InsiderSentiments>, Integer, Hash)> insider_sentiment_with_http_info(symbol, from, to)
|
3058
|
+
|
3059
|
+
```ruby
|
3060
|
+
begin
|
3061
|
+
# Insider Sentiment
|
3062
|
+
data, status_code, headers = api_instance.insider_sentiment_with_http_info(symbol, from, to)
|
3063
|
+
p status_code # => 2xx
|
3064
|
+
p headers # => { ... }
|
3065
|
+
p data # => <InsiderSentiments>
|
3066
|
+
rescue FinnhubRuby::ApiError => e
|
3067
|
+
puts "Error when calling DefaultApi->insider_sentiment_with_http_info: #{e}"
|
3068
|
+
end
|
3069
|
+
```
|
3070
|
+
|
3071
|
+
### Parameters
|
3072
|
+
|
3073
|
+
| Name | Type | Description | Notes |
|
3074
|
+
| ---- | ---- | ----------- | ----- |
|
3075
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
3076
|
+
| **from** | **Date** | From date: 2020-03-15. | |
|
3077
|
+
| **to** | **Date** | To date: 2020-03-16. | |
|
3078
|
+
|
3079
|
+
### Return type
|
3080
|
+
|
3081
|
+
[**InsiderSentiments**](InsiderSentiments.md)
|
3082
|
+
|
3083
|
+
### Authorization
|
3084
|
+
|
3085
|
+
[api_key](../README.md#api_key)
|
3086
|
+
|
3087
|
+
### HTTP request headers
|
3088
|
+
|
3089
|
+
- **Content-Type**: Not defined
|
3090
|
+
- **Accept**: application/json
|
3091
|
+
|
3092
|
+
|
3011
3093
|
## insider_transactions
|
3012
3094
|
|
3013
3095
|
> <InsiderTransactions> insider_transactions(symbol, opts)
|
@@ -3091,7 +3173,7 @@ end
|
|
3091
3173
|
|
3092
3174
|
International Filings
|
3093
3175
|
|
3094
|
-
List filings for international companies
|
3176
|
+
List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
3095
3177
|
|
3096
3178
|
### Examples
|
3097
3179
|
|
@@ -4863,7 +4945,7 @@ end
|
|
4863
4945
|
|
4864
4946
|
Stock Symbol
|
4865
4947
|
|
4866
|
-
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>.
|
4948
|
+
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>.
|
4867
4949
|
|
4868
4950
|
### Examples
|
4869
4951
|
|
@@ -4942,7 +5024,7 @@ end
|
|
4942
5024
|
|
4943
5025
|
Tick Data
|
4944
5026
|
|
4945
|
-
<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>
|
5027
|
+
<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>
|
4946
5028
|
|
4947
5029
|
### Examples
|
4948
5030
|
|
@@ -5013,13 +5095,163 @@ end
|
|
5013
5095
|
- **Accept**: application/json
|
5014
5096
|
|
5015
5097
|
|
5098
|
+
## stock_uspto_patent
|
5099
|
+
|
5100
|
+
> <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
|
5101
|
+
|
5102
|
+
USPTO Patents
|
5103
|
+
|
5104
|
+
List USPTO patents for companies. Limit to 250 records per API call.
|
5105
|
+
|
5106
|
+
### Examples
|
5107
|
+
|
5108
|
+
```ruby
|
5109
|
+
require 'time'
|
5110
|
+
require 'finnhub_ruby'
|
5111
|
+
# setup authorization
|
5112
|
+
FinnhubRuby.configure do |config|
|
5113
|
+
# Configure API key authorization: api_key
|
5114
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5115
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5116
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5117
|
+
end
|
5118
|
+
|
5119
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5120
|
+
symbol = 'symbol_example' # String | Symbol.
|
5121
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
5122
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
5123
|
+
|
5124
|
+
begin
|
5125
|
+
# USPTO Patents
|
5126
|
+
result = api_instance.stock_uspto_patent(symbol, from, to)
|
5127
|
+
p result
|
5128
|
+
rescue FinnhubRuby::ApiError => e
|
5129
|
+
puts "Error when calling DefaultApi->stock_uspto_patent: #{e}"
|
5130
|
+
end
|
5131
|
+
```
|
5132
|
+
|
5133
|
+
#### Using the stock_uspto_patent_with_http_info variant
|
5134
|
+
|
5135
|
+
This returns an Array which contains the response data, status code and headers.
|
5136
|
+
|
5137
|
+
> <Array(<UsptoPatentResult>, Integer, Hash)> stock_uspto_patent_with_http_info(symbol, from, to)
|
5138
|
+
|
5139
|
+
```ruby
|
5140
|
+
begin
|
5141
|
+
# USPTO Patents
|
5142
|
+
data, status_code, headers = api_instance.stock_uspto_patent_with_http_info(symbol, from, to)
|
5143
|
+
p status_code # => 2xx
|
5144
|
+
p headers # => { ... }
|
5145
|
+
p data # => <UsptoPatentResult>
|
5146
|
+
rescue FinnhubRuby::ApiError => e
|
5147
|
+
puts "Error when calling DefaultApi->stock_uspto_patent_with_http_info: #{e}"
|
5148
|
+
end
|
5149
|
+
```
|
5150
|
+
|
5151
|
+
### Parameters
|
5152
|
+
|
5153
|
+
| Name | Type | Description | Notes |
|
5154
|
+
| ---- | ---- | ----------- | ----- |
|
5155
|
+
| **symbol** | **String** | Symbol. | |
|
5156
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
5157
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
5158
|
+
|
5159
|
+
### Return type
|
5160
|
+
|
5161
|
+
[**UsptoPatentResult**](UsptoPatentResult.md)
|
5162
|
+
|
5163
|
+
### Authorization
|
5164
|
+
|
5165
|
+
[api_key](../README.md#api_key)
|
5166
|
+
|
5167
|
+
### HTTP request headers
|
5168
|
+
|
5169
|
+
- **Content-Type**: Not defined
|
5170
|
+
- **Accept**: application/json
|
5171
|
+
|
5172
|
+
|
5173
|
+
## stock_visa_application
|
5174
|
+
|
5175
|
+
> <VisaApplicationResult> stock_visa_application(symbol, from, to)
|
5176
|
+
|
5177
|
+
H1-B Visa Application
|
5178
|
+
|
5179
|
+
Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
|
5180
|
+
|
5181
|
+
### Examples
|
5182
|
+
|
5183
|
+
```ruby
|
5184
|
+
require 'time'
|
5185
|
+
require 'finnhub_ruby'
|
5186
|
+
# setup authorization
|
5187
|
+
FinnhubRuby.configure do |config|
|
5188
|
+
# Configure API key authorization: api_key
|
5189
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5191
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5192
|
+
end
|
5193
|
+
|
5194
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5195
|
+
symbol = 'symbol_example' # String | Symbol.
|
5196
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
|
5197
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
|
5198
|
+
|
5199
|
+
begin
|
5200
|
+
# H1-B Visa Application
|
5201
|
+
result = api_instance.stock_visa_application(symbol, from, to)
|
5202
|
+
p result
|
5203
|
+
rescue FinnhubRuby::ApiError => e
|
5204
|
+
puts "Error when calling DefaultApi->stock_visa_application: #{e}"
|
5205
|
+
end
|
5206
|
+
```
|
5207
|
+
|
5208
|
+
#### Using the stock_visa_application_with_http_info variant
|
5209
|
+
|
5210
|
+
This returns an Array which contains the response data, status code and headers.
|
5211
|
+
|
5212
|
+
> <Array(<VisaApplicationResult>, Integer, Hash)> stock_visa_application_with_http_info(symbol, from, to)
|
5213
|
+
|
5214
|
+
```ruby
|
5215
|
+
begin
|
5216
|
+
# H1-B Visa Application
|
5217
|
+
data, status_code, headers = api_instance.stock_visa_application_with_http_info(symbol, from, to)
|
5218
|
+
p status_code # => 2xx
|
5219
|
+
p headers # => { ... }
|
5220
|
+
p data # => <VisaApplicationResult>
|
5221
|
+
rescue FinnhubRuby::ApiError => e
|
5222
|
+
puts "Error when calling DefaultApi->stock_visa_application_with_http_info: #{e}"
|
5223
|
+
end
|
5224
|
+
```
|
5225
|
+
|
5226
|
+
### Parameters
|
5227
|
+
|
5228
|
+
| Name | Type | Description | Notes |
|
5229
|
+
| ---- | ---- | ----------- | ----- |
|
5230
|
+
| **symbol** | **String** | Symbol. | |
|
5231
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column. | |
|
5232
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column. | |
|
5233
|
+
|
5234
|
+
### Return type
|
5235
|
+
|
5236
|
+
[**VisaApplicationResult**](VisaApplicationResult.md)
|
5237
|
+
|
5238
|
+
### Authorization
|
5239
|
+
|
5240
|
+
[api_key](../README.md#api_key)
|
5241
|
+
|
5242
|
+
### HTTP request headers
|
5243
|
+
|
5244
|
+
- **Content-Type**: Not defined
|
5245
|
+
- **Accept**: application/json
|
5246
|
+
|
5247
|
+
|
5016
5248
|
## supply_chain_relationships
|
5017
5249
|
|
5018
5250
|
> <SupplyChainRelationships> supply_chain_relationships(symbol)
|
5019
5251
|
|
5020
5252
|
Supply Chain Relationships
|
5021
5253
|
|
5022
|
-
<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
|
5254
|
+
<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>
|
5023
5255
|
|
5024
5256
|
### Examples
|
5025
5257
|
|
@@ -5388,7 +5620,7 @@ end
|
|
5388
5620
|
|
5389
5621
|
Earnings Call Transcripts List
|
5390
5622
|
|
5391
|
-
List earnings call transcripts' metadata. This endpoint is available for US, UK and Canadian companies.
|
5623
|
+
List earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.
|
5392
5624
|
|
5393
5625
|
### Examples
|
5394
5626
|
|
@@ -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
|
+
|
data/docs/StockSymbol.md
CHANGED
@@ -10,7 +10,10 @@
|
|
10
10
|
| **type** | **String** | Security type. | [optional] |
|
11
11
|
| **mic** | **String** | Primary exchange's MIC. | [optional] |
|
12
12
|
| **figi** | **String** | FIGI identifier. | [optional] |
|
13
|
+
| **share_class_figi** | **String** | Global Share Class FIGI. | [optional] |
|
13
14
|
| **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional] |
|
15
|
+
| **symbol2** | **String** | Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE. | [optional] |
|
16
|
+
| **isin** | **String** | ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field. | [optional] |
|
14
17
|
|
15
18
|
## Example
|
16
19
|
|
@@ -24,7 +27,10 @@ instance = FinnhubRuby::StockSymbol.new(
|
|
24
27
|
type: null,
|
25
28
|
mic: null,
|
26
29
|
figi: null,
|
27
|
-
|
30
|
+
share_class_figi: null,
|
31
|
+
currency: null,
|
32
|
+
symbol2: null,
|
33
|
+
isin: null
|
28
34
|
)
|
29
35
|
```
|
30
36
|
|
data/docs/UsptoPatent.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **application_number** | **String** | Application Number. | [optional] |
|
8
|
+
| **company_filing_name** | **Array<String>** | Array of companies' name on the patent. | [optional] |
|
9
|
+
| **filing_date** | **String** | Filing date. | [optional] |
|
10
|
+
| **description** | **String** | Description. | [optional] |
|
11
|
+
| **filing_status** | **String** | Filing status. | [optional] |
|
12
|
+
| **patent_number** | **String** | Patent number. | [optional] |
|
13
|
+
| **publication_date** | **String** | Publication date. | [optional] |
|
14
|
+
| **patent_type** | **String** | Patent's type. | [optional] |
|
15
|
+
| **url** | **String** | URL of the original article. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::UsptoPatent.new(
|
23
|
+
application_number: null,
|
24
|
+
company_filing_name: null,
|
25
|
+
filing_date: null,
|
26
|
+
description: null,
|
27
|
+
filing_status: null,
|
28
|
+
patent_number: null,
|
29
|
+
publication_date: null,
|
30
|
+
patent_type: null,
|
31
|
+
url: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatentResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **data** | [**Array<UsptoPatent>**](UsptoPatent.md) | Array of patents. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::UsptoPatentResult.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# FinnhubRuby::VisaApplication
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **year** | **Integer** | Year. | [optional] |
|
8
|
+
| **quarter** | **Integer** | Quarter. | [optional] |
|
9
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
10
|
+
| **case_number** | **String** | Case number. | [optional] |
|
11
|
+
| **case_status** | **String** | Case status. | [optional] |
|
12
|
+
| **received_date** | **String** | Received date. | [optional] |
|
13
|
+
| **visa_class** | **String** | Visa class. | [optional] |
|
14
|
+
| **job_title** | **String** | Job Title. | [optional] |
|
15
|
+
| **soc_code** | **String** | SOC Code. A list of SOC code can be found <a href=\"https://www.bls.gov/oes/current/oes_stru.htm\" target=\"_blank\">here</a>. | [optional] |
|
16
|
+
| **full_time_position** | **String** | Full-time position flag. | [optional] |
|
17
|
+
| **begin_date** | **String** | Job's start date. | [optional] |
|
18
|
+
| **end_date** | **String** | Job's end date. | [optional] |
|
19
|
+
| **employer_name** | **String** | Company's name. | [optional] |
|
20
|
+
| **worksite_address** | **String** | Worksite address. | [optional] |
|
21
|
+
| **worksite_city** | **String** | Worksite city. | [optional] |
|
22
|
+
| **worksite_county** | **String** | Worksite county. | [optional] |
|
23
|
+
| **worksite_state** | **String** | Worksite state. | [optional] |
|
24
|
+
| **worksite_postal_code** | **String** | Worksite postal code. | [optional] |
|
25
|
+
| **wage_range_from** | **Float** | Wage range from. | [optional] |
|
26
|
+
| **wage_range_to** | **Float** | Wage range to. | [optional] |
|
27
|
+
| **wage_unit_of_pay** | **String** | Wage unit of pay. | [optional] |
|
28
|
+
| **wage_level** | **String** | Wage level. | [optional] |
|
29
|
+
| **h1b_dependent** | **String** | H1B dependent flag. | [optional] |
|
30
|
+
|
31
|
+
## Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'finnhub_ruby'
|
35
|
+
|
36
|
+
instance = FinnhubRuby::VisaApplication.new(
|
37
|
+
year: null,
|
38
|
+
quarter: null,
|
39
|
+
symbol: null,
|
40
|
+
case_number: null,
|
41
|
+
case_status: null,
|
42
|
+
received_date: null,
|
43
|
+
visa_class: null,
|
44
|
+
job_title: null,
|
45
|
+
soc_code: null,
|
46
|
+
full_time_position: null,
|
47
|
+
begin_date: null,
|
48
|
+
end_date: null,
|
49
|
+
employer_name: null,
|
50
|
+
worksite_address: null,
|
51
|
+
worksite_city: null,
|
52
|
+
worksite_county: null,
|
53
|
+
worksite_state: null,
|
54
|
+
worksite_postal_code: null,
|
55
|
+
wage_range_from: null,
|
56
|
+
wage_range_to: null,
|
57
|
+
wage_unit_of_pay: null,
|
58
|
+
wage_level: null,
|
59
|
+
h1b_dependent: null
|
60
|
+
)
|
61
|
+
```
|
62
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::VisaApplicationResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **data** | [**Array<VisaApplication>**](VisaApplication.md) | Array of H1b and Permanent visa applications. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::VisaApplicationResult.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
Binary file
|
Binary file
|
Binary file
|