finnhub_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de8916477d0d0d1e0cfeda7a345f9d4c032f00935b2370185ced41d3b76f6a10
+  data.tar.gz: e1ead83675e018c4b3786f7ea266325ddce0689b0c951e7108c94ffa2e543de1
+SHA512:
+  metadata.gz: 2e35788aebdf5a7389b1b7b14d542b5bb5028dbbf48ca929e754c612ad1b85e4c010b88a1a558135f3979b1c074a0c85aa0c9afe484dd70334f9b889353f8b90
+  data.tar.gz: 51472f755e60b7c8ea8e2ef38a4af31676e15ce170cd17c1e9991bea8efe5decc41cb18c6aea58baf45e8aad6c46bc6480db61309b074e4607075e0dd34b5734

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,164 @@
+# finnhub-python
+- API documentation: https://finnhub.io/docs/api
+- API version: 1.0.0
+- Package version: 1.0.0
+
+## Installation
+
+```sh
+gem install finnhub_ruby
+```
+
+or in your Gemfile
+
+```ruby
+gem 'finnhub_ruby', '~> 0.0.1'
+```
+
+## Getting Started
+
+```ruby
+require 'finnhub_ruby'
+
+FinnhubRuby.configure do |config|
+  config.api_key['token'] = 'YOUR API KEY'
+end
+
+finnhub_client = FinnhubRuby::DefaultApi.new
+
+# Stock candles
+puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
+
+# Aggregate Indicators
+puts(finnhub_client.aggregate_indicator('AAPL', 'D'))
+
+# Basic financials
+puts(finnhub_client.company_basic_financials('AAPL', 'margin'))
+
+# Earnings surprises
+puts(finnhub_client.company_earnings('TSLA', {limit: 5}))
+
+# EPS estimates
+puts(finnhub_client.company_eps_estimates('AMZN', {freq: 'quarterly'}))
+
+# Company Executives
+puts(finnhub_client.company_executive('AAPL'))
+
+# Company News
+# Need to use _from instead of from to avoid conflict
+puts(finnhub_client.company_news('AAPL', "2020-06-01", "2020-06-10"))
+
+# Company Peers
+puts(finnhub_client.company_peers('AAPL'))
+
+# Company Profile
+puts(finnhub_client.company_profile({symbol: 'AAPL'}))
+puts(finnhub_client.company_profile({isin: 'US0378331005'}))
+puts(finnhub_client.company_profile({cusip: '037833100'}))
+
+# Company Profile 2
+puts(finnhub_client.company_profile2({symbol: 'AAPL'}))
+
+# Revenue Estimates
+puts(finnhub_client.company_revenue_estimates('TSLA', {freq: 'quarterly'}))
+
+# List country
+puts(finnhub_client.country())
+
+# Crypto Exchange
+puts(finnhub_client.crypto_exchanges())
+
+# Crypto symbols
+puts(finnhub_client.crypto_symbols('BINANCE'))
+
+# Economic data
+puts(finnhub_client.economic_data('MA-USA-656880'))
+
+# Filings
+puts(finnhub_client.filings({symbol: 'AAPL', from: "2020-01-01", to: "2020-06-11"}))
+
+# Financials
+puts(finnhub_client.financials('AAPL', 'bs', 'annual'))
+
+# Financials as reported
+puts(finnhub_client.financials_reported({symbol: 'AAPL', freq: 'annual'}))
+
+# Forex exchanges
+puts(finnhub_client.forex_exchanges())
+
+# Forex all pairs
+puts(finnhub_client.forex_rates({base: 'USD'}))
+
+# Forex symbols
+puts(finnhub_client.forex_symbols('OANDA'))
+
+# Fund Ownership
+puts(finnhub_client.fund_ownership('AMZN', {limit: 5}))
+
+# General news
+puts(finnhub_client.general_news('forex', {min_id: 0}))
+
+# Investors ownership
+puts(finnhub_client.investors_ownership('AAPL', {limit: 5}))
+
+# IPO calendar
+puts(finnhub_client.ipo_calendar("2020-05-01", "2020-06-01"))
+
+# Major developments
+puts(finnhub_client.major_developments('AAPL', {from: "2020-01-01", to: "2020-12-31"}))
+
+# News sentiment
+puts(finnhub_client.news_sentiment('AAPL'))
+
+# Pattern recognition
+puts(finnhub_client.pattern_recognition('AAPL', 'D'))
+
+# Price target
+puts(finnhub_client.price_target('AAPL'))
+
+# Quote
+puts(finnhub_client.quote('AAPL'))
+
+# Recommendation trends
+puts(finnhub_client.recommendation_trends('AAPL'))
+
+# Stock dividends
+puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
+
+# Transcripts
+puts(finnhub_client.transcripts('AAPL_162777'))
+
+# Transcripts list
+puts(finnhub_client.transcripts_list('AAPL'))
+
+# Earnings Calendar
+puts(finnhub_client.earnings_calendar({from: "2020-06-10", to: "2020-06-30", symbol: "", international: false}))
+
+# Covid-19
+puts(finnhub_client.covid19())
+
+# Upgrade downgrade
+puts(finnhub_client.upgrade_downgrade({symbol: 'AAPL', from: '2020-01-01', to: '2020-06-30'}))
+
+# Support resistance
+puts(finnhub_client.support_resistance('AAPL', 'D'))
+
+# Stock splits
+puts(finnhub_client.stock_splits('AAPL', '2000-01-01', '2020-01-01'))
+
+# Forex candles
+puts(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
+
+# Crypto Candles
+puts(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
+
+# Tick Data
+puts(finnhub_client.stock_tick_with_http_info('AAPL', '2020-03-25', 500, 0))
+
+# Technical Indicator
+puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
+```
+
+## License
+
+Apache License

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AggregateIndicators.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::AggregateIndicators
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**technical_analysis** | [**TechnicalAnalysis**](TechnicalAnalysis.md) |  | [optional] 
+**trend** | [**Trend**](Trend.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::AggregateIndicators.new(technical_analysis: null,
+                                 trend: null)
+```
+
+

data/docs/BasicFinancials.md

@@ -0,0 +1,21 @@
+# FinnhubRuby::BasicFinancials
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol of the company. | [optional] 
+**metric_type** | **String** | Metric type. | [optional] 
+**metric** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::BasicFinancials.new(symbol: null,
+                                 metric_type: null,
+                                 metric: null)
+```
+
+

data/docs/Company.md

@@ -0,0 +1,29 @@
+# FinnhubRuby::Company
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Executive name | [optional] 
+**age** | **Integer** | Age | [optional] 
+**title** | **String** | Title | [optional] 
+**since** | **String** | Year appointed | [optional] 
+**sex** | **String** | Sex | [optional] 
+**compensation** | **Integer** | Total compensation | [optional] 
+**currency** | **String** | Compensation currency | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Company.new(name: null,
+                                 age: null,
+                                 title: null,
+                                 since: null,
+                                 sex: null,
+                                 compensation: null,
+                                 currency: null)
+```
+
+