# finnhub-python
- API documentation: https://finnhub.io/docs/api
- API version: 1.0.0
- Package version: 2.4.22
## 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
Raw data
{
"_id": null,
"home_page": "https://finnhub.io/docs/api",
"name": "finnhub-python",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "finnhub, Finnhub API, api",
"author": "Finnhub",
"author_email": "support@finnhub.io",
"download_url": "https://files.pythonhosted.org/packages/d8/24/cdf1f458109c07300af52720ffe26ee55c10e97d46f19b5478719fcb3c34/finnhub_python-2.4.22.tar.gz",
"platform": null,
"description": "# finnhub-python\n\n- API documentation: https://finnhub.io/docs/api\n- API version: 1.0.0\n- Package version: 2.4.22\n\n## Installation\n\nInstall package\n\n```sh\npip install finnhub-python\n```\n\n## Getting Started\n\nRefer to [CHANGELOG](https://github.com/Finnhub-Stock-API/finnhub-python/blob/master/CHANGELOG.md) If you are coming from version 1\n\n```python\nimport finnhub\n\n# Setup client\nfinnhub_client = finnhub.Client(api_key=\"YOUR API KEY\")\n\n# Stock candles\nres = finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249)\nprint(res)\n\n#Convert to Pandas Dataframe\nimport pandas as pd\nprint(pd.DataFrame(res))\n\n# Aggregate Indicators\nprint(finnhub_client.aggregate_indicator('AAPL', 'D'))\n\n# Basic financials\nprint(finnhub_client.company_basic_financials('AAPL', 'all'))\n\n# Earnings surprises\nprint(finnhub_client.company_earnings('TSLA', limit=5))\n\n# EPS estimates\nprint(finnhub_client.company_eps_estimates('AMZN', freq='quarterly'))\n\n# Company Executives\nprint(finnhub_client.company_executive('AAPL'))\n\n# Company News\n# Need to use _from instead of from to avoid conflict\nprint(finnhub_client.company_news('AAPL', _from=\"2020-06-01\", to=\"2020-06-10\"))\n\n# Company Peers\nprint(finnhub_client.company_peers('AAPL'))\n\n# Company Profile\nprint(finnhub_client.company_profile(symbol='AAPL'))\nprint(finnhub_client.company_profile(isin='US0378331005'))\nprint(finnhub_client.company_profile(cusip='037833100'))\n\n# Company Profile 2\nprint(finnhub_client.company_profile2(symbol='AAPL'))\n\n# Revenue Estimates\nprint(finnhub_client.company_revenue_estimates('TSLA', freq='quarterly'))\n\n# List country\nprint(finnhub_client.country())\n\n# Crypto Exchange\nprint(finnhub_client.crypto_exchanges())\n\n# Crypto symbols\nprint(finnhub_client.crypto_symbols('BINANCE'))\n\n# Economic data\nprint(finnhub_client.economic_data('MA-USA-656880'))\n\n# Filings\nprint(finnhub_client.filings(symbol='AAPL', _from=\"2020-01-01\", to=\"2020-06-11\"))\n\n# Financials\nprint(finnhub_client.financials('AAPL', 'bs', 'annual'))\n\n# Financials as reported\nprint(finnhub_client.financials_reported(symbol='AAPL', freq='annual'))\n\n# Forex exchanges\nprint(finnhub_client.forex_exchanges())\n\n# Forex all pairs\nprint(finnhub_client.forex_rates(base='USD'))\n\n# Forex symbols\nprint(finnhub_client.forex_symbols('OANDA'))\n\n# Fund Ownership\nprint(finnhub_client.fund_ownership('AMZN', limit=5))\n\n# General news\nprint(finnhub_client.general_news('forex', min_id=0))\n\n# Investors ownership\nprint(finnhub_client.ownership('AAPL', limit=5))\n\n# IPO calendar\nprint(finnhub_client.ipo_calendar(_from=\"2020-05-01\", to=\"2020-06-01\"))\n\n# Major developments\nprint(finnhub_client.press_releases('AAPL', _from=\"2020-01-01\", to=\"2020-12-31\"))\n\n# News sentiment\nprint(finnhub_client.news_sentiment('AAPL'))\n\n# Pattern recognition\nprint(finnhub_client.pattern_recognition('AAPL', 'D'))\n\n# Price target\nprint(finnhub_client.price_target('AAPL'))\n\n# Quote\nprint(finnhub_client.quote('AAPL'))\n\n# Recommendation trends\nprint(finnhub_client.recommendation_trends('AAPL'))\n\n# Stock dividends\nprint(finnhub_client.stock_dividends('KO', _from='2019-01-01', to='2020-01-01'))\n\n# Stock dividends 2\nprint(finnhub_client.stock_basic_dividends(\"KO\"))\n\n# Stock symbols\nprint(finnhub_client.stock_symbols('US')[0:5])\n\n# Transcripts\nprint(finnhub_client.transcripts('AAPL_162777'))\n\n# Transcripts list\nprint(finnhub_client.transcripts_list('AAPL'))\n\n# Earnings Calendar\nprint(finnhub_client.earnings_calendar(_from=\"2020-06-10\", to=\"2020-06-30\", symbol=\"\", international=False))\n\n# Covid-19\nprint(finnhub_client.covid19())\n\n# Upgrade downgrade\nprint(finnhub_client.upgrade_downgrade(symbol='AAPL', _from='2020-01-01', to='2020-06-30'))\n\n# Economic code\nprint(finnhub_client.economic_code()[0:5])\n\n# Economic calendar\nprint(finnhub_client.calendar_economic('2021-01-01', '2021-01-07'))\n\n# Support resistance\nprint(finnhub_client.support_resistance('AAPL', 'D'))\n\n# Technical Indicator\nprint(finnhub_client.technical_indicator(symbol=\"AAPL\", resolution='D', _from=1583098857, to=1584308457, indicator='rsi', indicator_fields={\"timeperiod\": 3}))\n\n# Stock splits\nprint(finnhub_client.stock_splits('AAPL', _from='2000-01-01', to='2020-01-01'))\n\n# Forex candles\nprint(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))\n\n# Crypto Candles\nprint(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))\n\n# Tick Data\nprint(finnhub_client.stock_tick('AAPL', '2020-03-25', 500, 0))\n\n# BBO Data\nprint(finnhub_client.stock_nbbo(\"AAPL\", \"2020-03-25\", 500, 0))\n\n# Indices Constituents\nprint(finnhub_client.indices_const(symbol = \"^GSPC\"))\n\n# Indices Historical Constituents\nprint(finnhub_client.indices_hist_const(symbol = \"^GSPC\"))\n\n# ETFs Profile\nprint(finnhub_client.etfs_profile('SPY'))\nprint(finnhub_client.etfs_profile(isin=\"US78462F1030\"))\n\n# ETFs Holdings\nprint(finnhub_client.etfs_holdings('SPY'))\nprint(finnhub_client.etfs_holdings(isin=\"US00214Q1040\", skip=2))\nprint(finnhub_client.etfs_holdings(\"IPO\", date='2022-03-10'))\n\n# ETFs Sector Exposure\nprint(finnhub_client.etfs_sector_exp('SPY'))\n\n# ETFs Country Exposure\nprint(finnhub_client.etfs_country_exp('SPY'))\n\n# International Filings\nprint(finnhub_client.international_filings('RY.TO'))\nprint(finnhub_client.international_filings(country='GB'))\n\n# SEC Sentiment Analysis\nprint(finnhub_client.sec_sentiment_analysis('0000320193-20-000052'))\n\n# SEC similarity index\nprint(finnhub_client.sec_similarity_index('AAPL'))\n\n# Bid Ask\nprint(finnhub_client.last_bid_ask('AAPL'))\n\n# FDA Calendar\nprint(finnhub_client.fda_calendar())\n\n# Symbol lookup\nprint(finnhub_client.symbol_lookup('apple'))\n\n# Insider transactions\nprint(finnhub_client.stock_insider_transactions('AAPL', '2021-01-01', '2021-03-01'))\n\n# Mutual Funds Profile\nprint(finnhub_client.mutual_fund_profile(\"VTSAX\"))\nprint(finnhub_client.mutual_fund_profile(isin=\"US9229087286\"))\n\n# Mutual Funds Holdings\nprint(finnhub_client.mutual_fund_holdings(\"VTSAX\"))\nprint(finnhub_client.mutual_fund_holdings(isin=\"US9229087286\", skip=2))\n\n# Mutual Funds Sector Exposure\nprint(finnhub_client.mutual_fund_sector_exp(\"VTSAX\"))\n\n# Mutual Funds Country Exposure\nprint(finnhub_client.mutual_fund_country_exp(\"VTSAX\"))\n\n# Revenue breakdown\nprint(finnhub_client.stock_revenue_breakdown('AAPL'))\n\n# Social sentiment\nprint(finnhub_client.stock_social_sentiment('GME'))\n\n# Investment Themes\nprint(finnhub_client.stock_investment_theme('financialExchangesData'))\n\n# Supply chain\nprint(finnhub_client.stock_supply_chain('AAPL'))\n\n# Company ESG\nprint(finnhub_client.company_esg_score(\"AAPL\"))\n\n# Earnings Quality Score\nprint(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))\n\n# Crypto Profile\nprint(finnhub_client.crypto_profile('BTC'))\n\n# EBITDA Estimates\nprint(finnhub_client.company_ebitda_estimates(\"TSLA\", freq=\"quarterly\"))\n\n# EBIT Estimates\nprint(finnhub_client.company_ebit_estimates(\"TSLA\", freq=\"quarterly\"))\n\n# USPTO Patent\nprint(finnhub_client.stock_uspto_patent(\"AAPL\", \"2021-01-01\", \"2021-12-31\"))\n\n# Visa application\nprint(finnhub_client.stock_visa_application(\"AAPL\", \"2021-01-01\", \"2022-06-15\"))\n\n# Insider sentiment\nprint(finnhub_client.stock_insider_sentiment('AAPL', '2021-01-01', '2022-03-01'))\n\n# Bond Profile\nprint(finnhub_client.bond_profile(isin='US912810TD00'))\n\n# Bond price\nprint(finnhub_client.bond_price('US912810TD00', 1590988249, 1649099548))\n\n# Lobbying\nprint(finnhub_client.stock_lobbying(\"AAPL\", \"2021-01-01\", \"2022-06-15\"))\n\n# USA Spending\nprint(finnhub_client.stock_usa_spending(\"LMT\", \"2021-01-01\", \"2022-06-15\"))\n\n# Sector metrics\nprint(finnhub_client.sector_metric('NA'))\n\n## Fund's EET data\nprint(finnhub_client.mutual_fund_eet('LU2036931686'))\nprint(finnhub_client.mutual_fund_eet_pai('LU2036931686'))\n\n# Symbol & ISIN change\nprint(finnhub_client.isin_change(_from='2022-10-01', to='2022-10-07'))\nprint(finnhub_client.symbol_change(_from='2022-10-01', to='2022-10-07'))\n\n# 13-F data\nprint(finnhub_client.institutional_profile())\nprint(finnhub_client.institutional_portfolio(cik='1000097', _from='2022-01-01', to='2022-10-07'))\nprint(finnhub_client.institutional_ownership('TSLA', '', _from='2022-01-01', to='2022-10-07'))\n\n# Bond yield and FINRA Trace tick\nprint(finnhub_client.bond_yield_curve('10y'))\nprint(finnhub_client.bond_tick('US693475BF18', '2022-08-19', 500, 0, 'trace'))\n\n# Congressional Trading\nprint(finnhub_client.congressional_trading('AAPL', '2020-01-01', '2023-03-31'))\n\n# Price metrics with historical data\nprint(finnhub_client.price_metrics(symbol=\"AAPL\", date=\"2022-01-01\"))\n\n## Market Holday / Status\nprint(finnhub_client.market_holiday(exchange='US'))\nprint(finnhub_client.market_status(exchange='US'))\n\n```\n\n## License\n\nApache License\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Finnhub API",
"version": "2.4.22",
"project_urls": {
"Homepage": "https://finnhub.io/docs/api"
},
"split_keywords": [
"finnhub",
" finnhub api",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca4cf453b187319746a055a77b5a7b49b9d52ab6db91e14b72fa2f550d5b2d88",
"md5": "f5a21d8f47c544da7a4ef809e836984b",
"sha256": "323ea33b38df54a15b4cdc028677b35b4c577d01eb6734c7398094a681b8c503"
},
"downloads": -1,
"filename": "finnhub_python-2.4.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5a21d8f47c544da7a4ef809e836984b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11814,
"upload_time": "2024-11-24T15:38:37",
"upload_time_iso_8601": "2024-11-24T15:38:37.827522Z",
"url": "https://files.pythonhosted.org/packages/ca/4c/f453b187319746a055a77b5a7b49b9d52ab6db91e14b72fa2f550d5b2d88/finnhub_python-2.4.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d824cdf1f458109c07300af52720ffe26ee55c10e97d46f19b5478719fcb3c34",
"md5": "9b7248140230b0c0068ccb06b94e61d9",
"sha256": "deaceb7c56af8719b84aa714818dc95ffd272d362eb73e83d2dc8d667d386737"
},
"downloads": -1,
"filename": "finnhub_python-2.4.22.tar.gz",
"has_sig": false,
"md5_digest": "9b7248140230b0c0068ccb06b94e61d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13345,
"upload_time": "2024-11-24T15:38:39",
"upload_time_iso_8601": "2024-11-24T15:38:39.819594Z",
"url": "https://files.pythonhosted.org/packages/d8/24/cdf1f458109c07300af52720ffe26ee55c10e97d46f19b5478719fcb3c34/finnhub_python-2.4.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 15:38:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "finnhub-python"
}