finnhub_ruby 1.1.18 → 1.1.19
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/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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6286c442a46c71f6e4889a2fd3e6a01135f30737e0924438777eaf5d752a2326
|
4
|
+
data.tar.gz: 883025c7f6403f0648aa357184963292075405a7d294f19754f5f8f786dfbcbb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 76fc7fbc3af3031842ac6c706ab1ca41f08289743b5e0d899221a64a8504e7c1665ea4a80bf5c60f476881189036849a7d9e7efc27747e704177c359dbea959a
|
7
|
+
data.tar.gz: cfa14a11c9080cf6911673f4ccdf60d68d681875fcec38ac2e4f8b5a06d3232162a8ac56d66cd76536c51df441f748b91d97e8b216960e511d3d80f17a6a6429
|
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.19
|
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.19'
|
17
17
|
```
|
18
18
|
|
19
19
|
## Getting Started
|
data/docs/BondTickData.md
CHANGED
@@ -9,9 +9,12 @@
|
|
9
9
|
| **total** | **Integer** | Total number of ticks for that date. | [optional] |
|
10
10
|
| **v** | **Array<Float>** | List of volume data. | [optional] |
|
11
11
|
| **p** | **Array<Float>** | List of price data. | [optional] |
|
12
|
+
| **y** | **Array<Float>** | List of yield data. | [optional] |
|
12
13
|
| **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
|
13
14
|
| **si** | **Array<String>** | List of values showing the side (Buy/sell) of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
|
14
15
|
| **cp** | **Array<String>** | List of values showing the counterparty of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
|
16
|
+
| **rp** | **Array<String>** | List of values showing the reporting party of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
|
17
|
+
| **ats** | **Array<String>** | ATS flag. Y or empty | [optional] |
|
15
18
|
| **c** | **Array<Array<String>>** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\">here</a> | [optional] |
|
16
19
|
|
17
20
|
## Example
|
@@ -25,9 +28,12 @@ instance = FinnhubRuby::BondTickData.new(
|
|
25
28
|
total: null,
|
26
29
|
v: null,
|
27
30
|
p: null,
|
31
|
+
y: null,
|
28
32
|
t: null,
|
29
33
|
si: null,
|
30
34
|
cp: null,
|
35
|
+
rp: null,
|
36
|
+
ats: null,
|
31
37
|
c: null
|
32
38
|
)
|
33
39
|
```
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::BondYieldCurve
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<BondYieldCurveInfo>**](BondYieldCurveInfo.md) | Array of data. | [optional] |
|
8
|
+
| **code** | **String** | Bond's code | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::BondYieldCurve.new(
|
16
|
+
data: null,
|
17
|
+
code: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::BondYieldCurveInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **d** | **String** | Date of the reading | [optional] |
|
8
|
+
| **v** | **Float** | Value | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::BondYieldCurveInfo.new(
|
16
|
+
d: null,
|
17
|
+
v: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/CompanyProfile.md
CHANGED
@@ -7,7 +7,9 @@
|
|
7
7
|
| **address** | **String** | Address of company's headquarter. | [optional] |
|
8
8
|
| **city** | **String** | City of company's headquarter. | [optional] |
|
9
9
|
| **country** | **String** | Country of company's headquarter. | [optional] |
|
10
|
-
| **currency** | **String** | Currency used in company filings. | [optional] |
|
10
|
+
| **currency** | **String** | Currency used in company filings and financials. | [optional] |
|
11
|
+
| **estimate_currency** | **String** | Currency used in Estimates data. | [optional] |
|
12
|
+
| **market_cap_currency** | **String** | Currency used in market capitalization. | [optional] |
|
11
13
|
| **cusip** | **String** | CUSIP number. | [optional] |
|
12
14
|
| **sedol** | **String** | Sedol number. | [optional] |
|
13
15
|
| **description** | **String** | Company business summary. | [optional] |
|
@@ -43,6 +45,8 @@ instance = FinnhubRuby::CompanyProfile.new(
|
|
43
45
|
city: null,
|
44
46
|
country: null,
|
45
47
|
currency: null,
|
48
|
+
estimate_currency: null,
|
49
|
+
market_cap_currency: null,
|
46
50
|
cusip: null,
|
47
51
|
sedol: null,
|
48
52
|
description: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::CongressionalTrading
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
+
| **data** | [**Array<CongressionalTransaction>**](CongressionalTransaction.md) | Array of stock trades. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::CongressionalTrading.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# FinnhubRuby::CongressionalTransaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **amount_from** | **Float** | Transaction amount from. | [optional] |
|
8
|
+
| **amount_to** | **Float** | Transaction amount to. | [optional] |
|
9
|
+
| **asset_name** | **String** | Asset name. | [optional] |
|
10
|
+
| **filing_date** | **String** | Filing date. | [optional] |
|
11
|
+
| **name** | **String** | Name of the representative. | [optional] |
|
12
|
+
| **owner_type** | **String** | Owner Type. | [optional] |
|
13
|
+
| **position** | **String** | Position. | [optional] |
|
14
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
15
|
+
| **transaction_date** | **String** | Transaction date. | [optional] |
|
16
|
+
| **transaction_type** | **String** | Transaction type <code>Sale</code> or <code>Purchase</code>. | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'finnhub_ruby'
|
22
|
+
|
23
|
+
instance = FinnhubRuby::CongressionalTransaction.new(
|
24
|
+
amount_from: null,
|
25
|
+
amount_to: null,
|
26
|
+
asset_name: null,
|
27
|
+
filing_date: null,
|
28
|
+
name: null,
|
29
|
+
owner_type: null,
|
30
|
+
position: null,
|
31
|
+
symbol: null,
|
32
|
+
transaction_date: null,
|
33
|
+
transaction_type: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|