finnhub-python 2.4.19__tar.gz → 2.4.20__tar.gz

finnhub-python-2.4.20/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.

finnhub-python-2.4.20/PKG-INFO

@@ -0,0 +1,329 @@
+Metadata-Version: 2.1
+Name: finnhub-python
+Version: 2.4.20
+Summary: Finnhub API
+Home-page: https://finnhub.io/docs/api
+Author: Finnhub
+Author-email: support@finnhub.io
+License: Apache-2.0
+Keywords: finnhub,Finnhub API,api
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.22.0
+
+# finnhub-python
+
+- API documentation: https://finnhub.io/docs/api
+- API version: 1.0.0
+- Package version: 2.4.20
+
+## Installation
+
+Install package
+
+```sh
+pip install finnhub-python
+```
+
+## Getting Started
+
+Refer to [CHANGELOG](https://github.com/Finnhub-Stock-API/finnhub-python/blob/master/CHANGELOG.md) If you are coming from version 1
+
+```python
+import finnhub
+
+# Setup client
+finnhub_client = finnhub.Client(api_key="YOUR API KEY")
+
+# Stock candles
+res = finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249)
+print(res)
+
+#Convert to Pandas Dataframe
+import pandas as pd
+print(pd.DataFrame(res))
+
+# Aggregate Indicators
+print(finnhub_client.aggregate_indicator('AAPL', 'D'))
+
+# Basic financials
+print(finnhub_client.company_basic_financials('AAPL', 'all'))
+
+# Earnings surprises
+print(finnhub_client.company_earnings('TSLA', limit=5))
+
+# EPS estimates
+print(finnhub_client.company_eps_estimates('AMZN', freq='quarterly'))
+
+# Company Executives
+print(finnhub_client.company_executive('AAPL'))
+
+# Company News
+# Need to use _from instead of from to avoid conflict
+print(finnhub_client.company_news('AAPL', _from="2020-06-01", to="2020-06-10"))
+
+# Company Peers
+print(finnhub_client.company_peers('AAPL'))
+
+# Company Profile
+print(finnhub_client.company_profile(symbol='AAPL'))
+print(finnhub_client.company_profile(isin='US0378331005'))
+print(finnhub_client.company_profile(cusip='037833100'))
+
+# Company Profile 2
+print(finnhub_client.company_profile2(symbol='AAPL'))
+
+# Revenue Estimates
+print(finnhub_client.company_revenue_estimates('TSLA', freq='quarterly'))
+
+# List country
+print(finnhub_client.country())
+
+# Crypto Exchange
+print(finnhub_client.crypto_exchanges())
+
+# Crypto symbols
+print(finnhub_client.crypto_symbols('BINANCE'))
+
+# Economic data
+print(finnhub_client.economic_data('MA-USA-656880'))
+
+# Filings
+print(finnhub_client.filings(symbol='AAPL', _from="2020-01-01", to="2020-06-11"))
+
+# Financials
+print(finnhub_client.financials('AAPL', 'bs', 'annual'))
+
+# Financials as reported
+print(finnhub_client.financials_reported(symbol='AAPL', freq='annual'))
+
+# Forex exchanges
+print(finnhub_client.forex_exchanges())
+
+# Forex all pairs
+print(finnhub_client.forex_rates(base='USD'))
+
+# Forex symbols
+print(finnhub_client.forex_symbols('OANDA'))
+
+# Fund Ownership
+print(finnhub_client.fund_ownership('AMZN', limit=5))
+
+# General news
+print(finnhub_client.general_news('forex', min_id=0))
+
+# Investors ownership
+print(finnhub_client.ownership('AAPL', limit=5))
+
+# IPO calendar
+print(finnhub_client.ipo_calendar(_from="2020-05-01", to="2020-06-01"))
+
+# Major developments
+print(finnhub_client.press_releases('AAPL', _from="2020-01-01", to="2020-12-31"))
+
+# News sentiment
+print(finnhub_client.news_sentiment('AAPL'))
+
+# Pattern recognition
+print(finnhub_client.pattern_recognition('AAPL', 'D'))
+
+# Price target
+print(finnhub_client.price_target('AAPL'))
+
+# Quote
+print(finnhub_client.quote('AAPL'))
+
+# Recommendation trends
+print(finnhub_client.recommendation_trends('AAPL'))
+
+# Stock dividends
+print(finnhub_client.stock_dividends('KO', _from='2019-01-01', to='2020-01-01'))
+
+# Stock dividends 2
+print(finnhub_client.stock_basic_dividends("KO"))
+
+# Stock symbols
+print(finnhub_client.stock_symbols('US')[0:5])
+
+# Transcripts
+print(finnhub_client.transcripts('AAPL_162777'))
+
+# Transcripts list
+print(finnhub_client.transcripts_list('AAPL'))
+
+# Earnings Calendar
+print(finnhub_client.earnings_calendar(_from="2020-06-10", to="2020-06-30", symbol="", international=False))
+
+# Covid-19
+print(finnhub_client.covid19())
+
+# Upgrade downgrade
+print(finnhub_client.upgrade_downgrade(symbol='AAPL', _from='2020-01-01', to='2020-06-30'))
+
+# Economic code
+print(finnhub_client.economic_code()[0:5])
+
+# Economic calendar
+print(finnhub_client.calendar_economic('2021-01-01', '2021-01-07'))
+
+# Support resistance
+print(finnhub_client.support_resistance('AAPL', 'D'))
+
+# Technical Indicator
+print(finnhub_client.technical_indicator(symbol="AAPL", resolution='D', _from=1583098857, to=1584308457, indicator='rsi', indicator_fields={"timeperiod": 3}))
+
+# Stock splits
+print(finnhub_client.stock_splits('AAPL', _from='2000-01-01', to='2020-01-01'))
+
+# Forex candles
+print(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
+
+# Crypto Candles
+print(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
+
+# Tick Data
+print(finnhub_client.stock_tick('AAPL', '2020-03-25', 500, 0))
+
+# BBO Data
+print(finnhub_client.stock_nbbo("AAPL", "2020-03-25", 500, 0))
+
+# Indices Constituents
+print(finnhub_client.indices_const(symbol = "^GSPC"))
+
+# Indices Historical Constituents
+print(finnhub_client.indices_hist_const(symbol = "^GSPC"))
+
+# ETFs Profile
+print(finnhub_client.etfs_profile('SPY'))
+print(finnhub_client.etfs_profile(isin="US78462F1030"))
+
+# ETFs Holdings
+print(finnhub_client.etfs_holdings('SPY'))
+print(finnhub_client.etfs_holdings(isin="US00214Q1040", skip=2))
+print(finnhub_client.etfs_holdings("IPO", date='2022-03-10'))
+
+# ETFs Sector Exposure
+print(finnhub_client.etfs_sector_exp('SPY'))
+
+# ETFs Country Exposure
+print(finnhub_client.etfs_country_exp('SPY'))
+
+# International Filings
+print(finnhub_client.international_filings('RY.TO'))
+print(finnhub_client.international_filings(country='GB'))
+
+# SEC Sentiment Analysis
+print(finnhub_client.sec_sentiment_analysis('0000320193-20-000052'))
+
+# SEC similarity index
+print(finnhub_client.sec_similarity_index('AAPL'))
+
+# Bid Ask
+print(finnhub_client.last_bid_ask('AAPL'))
+
+# FDA Calendar
+print(finnhub_client.fda_calendar())
+
+# Symbol lookup
+print(finnhub_client.symbol_lookup('apple'))
+
+# Insider transactions
+print(finnhub_client.stock_insider_transactions('AAPL', '2021-01-01', '2021-03-01'))
+
+# Mutual Funds Profile
+print(finnhub_client.mutual_fund_profile("VTSAX"))
+print(finnhub_client.mutual_fund_profile(isin="US9229087286"))
+
+# Mutual Funds Holdings
+print(finnhub_client.mutual_fund_holdings("VTSAX"))
+print(finnhub_client.mutual_fund_holdings(isin="US9229087286", skip=2))
+
+# Mutual Funds Sector Exposure
+print(finnhub_client.mutual_fund_sector_exp("VTSAX"))
+
+# Mutual Funds Country Exposure
+print(finnhub_client.mutual_fund_country_exp("VTSAX"))
+
+# Revenue breakdown
+print(finnhub_client.stock_revenue_breakdown('AAPL'))
+
+# Social sentiment
+print(finnhub_client.stock_social_sentiment('GME'))
+
+# Investment Themes
+print(finnhub_client.stock_investment_theme('financialExchangesData'))
+
+# Supply chain
+print(finnhub_client.stock_supply_chain('AAPL'))
+
+# Company ESG
+print(finnhub_client.company_esg_score("AAPL"))
+
+# Earnings Quality Score
+print(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))
+
+# Crypto Profile
+print(finnhub_client.crypto_profile('BTC'))
+
+# EBITDA Estimates
+print(finnhub_client.company_ebitda_estimates("TSLA", freq="quarterly"))
+
+# EBIT Estimates
+print(finnhub_client.company_ebit_estimates("TSLA", freq="quarterly"))
+
+# USPTO Patent
+print(finnhub_client.stock_uspto_patent("AAPL", "2021-01-01", "2021-12-31"))
+
+# Visa application
+print(finnhub_client.stock_visa_application("AAPL", "2021-01-01", "2022-06-15"))
+
+# Insider sentiment
+print(finnhub_client.stock_insider_sentiment('AAPL', '2021-01-01', '2022-03-01'))
+
+# Bond Profile
+print(finnhub_client.bond_profile(isin='US912810TD00'))
+
+# Bond price
+print(finnhub_client.bond_price('US912810TD00', 1590988249, 1649099548))
+
+# Lobbying
+print(finnhub_client.stock_lobbying("AAPL", "2021-01-01", "2022-06-15"))
+
+# USA Spending
+print(finnhub_client.stock_usa_spending("LMT", "2021-01-01", "2022-06-15"))
+
+# Sector metrics
+print(finnhub_client.sector_metric('NA'))
+
+## Fund's EET data
+print(finnhub_client.mutual_fund_eet('LU2036931686'))
+print(finnhub_client.mutual_fund_eet_pai('LU2036931686'))
+
+# Symbol & ISIN change
+print(finnhub_client.isin_change(_from='2022-10-01', to='2022-10-07'))
+print(finnhub_client.symbol_change(_from='2022-10-01', to='2022-10-07'))
+
+# 13-F data
+print(finnhub_client.institutional_profile())
+print(finnhub_client.institutional_portfolio(cik='1000097', _from='2022-01-01', to='2022-10-07'))
+print(finnhub_client.institutional_ownership('TSLA', '', _from='2022-01-01', to='2022-10-07'))
+
+# Bond yield and FINRA Trace tick
+print(finnhub_client.bond_yield_curve('10y'))
+print(finnhub_client.bond_tick('US693475BF18', '2022-08-19', 500, 0, 'trace'))
+
+# Congressional Trading
+print(finnhub_client.congressional_trading('AAPL', '2020-01-01', '2023-03-31'))
+
+# Price metrics with historical data
+print(finnhub_client.price_metrics(symbol="AAPL", date="2022-01-01"))
+
+## Market Holday / Status
+print(finnhub_client.market_holiday(exchange='US'))
+print(finnhub_client.market_status(exchange='US'))
+
+```
+
+## License
+
+Apache License

{finnhub-python-2.4.19 → finnhub-python-2.4.20}/README.md

@@ -2,7 +2,7 @@
 
 - API documentation: https://finnhub.io/docs/api
 - API version: 1.0.0
-- Package version: 2.4.19
+- Package version: 2.4.20
 
 ## Installation
 

{finnhub-python-2.4.19 → finnhub-python-2.4.20}/finnhub/client.py

@@ -432,6 +432,12 @@ class Client:
     def company_esg_score(self, symbol):
         return self._get("/stock/esg", params={"symbol": symbol})
 
+    def company_historical_esg_score(self, symbol):
+        return self._get("/stock/historical-esg", params={"symbol": symbol})
+
+    def historical_market_cap(self, symbol, _from=None, to=None):
+        return self._get("/stock/historical-market-cap", params={"symbol": symbol, "from": _from, "to": to})
+
     def company_earnings_quality_score(self, symbol, freq):
         return self._get("/stock/earnings-quality-score", params={"symbol": symbol, 'freq': freq})