finnhub-python

When calling company_news, you must use the parameter name _from instead of from to avoid a Python syntax conflict with the reserved from keyword.

# Use _from instead of from to avoid conflict
print(finnhub_client.company_news('AAPL', _from="2020-06-01", to="2020-06-10'))

To use the library, import finnhub and instantiate a finnhub.Client using your Finnhub API key.

import finnhub

# Setup client
finnhub_client = finnhub.Client(api_key="YOUR API KEY")

Install the Finnhub Python client library using pip:

pip install finnhub-python

You can look up company profiles using a symbol, isin, or cusip.

print(finnhub_client.company_profile(symbol='AAPL'))
print(finnhub_client.company_profile(isin='US0378331005'))
print(finnhub_client.company_profile(cusip='037833100'))

# Alternative profile method
print(finnhub_client.company_profile2(symbol='AAPL'))

Retrieve information regarding ETFs and Mutual Funds:

• etfs_profile(symbol/isin): Get ETF profile.
• etfs_holdings(symbol/isin, skip, date): Get ETF holdings.
• etfs_sector_exp(symbol): Get ETF sector exposure.
• etfs_country_exp(symbol): Get ETF country exposure.
• mutual_fund_profile(symbol/isin): Get Mutual Fund profile.
• mutual_fund_holdings(symbol/isin, skip): Get Mutual Fund holdings.

# ETFs
print(finnhub_client.etfs_profile('SPY'))
print(finnhub_client.etfs_holdings('SPY'))

# Mutual Funds
print(finnhub_client.mutual_fund_profile("VTSAX"))
print(finnhub_client.mutual_fund_holdings("VTSAX"))

Retrieve historical stock candle data (OHLCV). Note that timestamps are typically required for the time range.

# res contains the candle data
res = finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249)
print(res)

The client provides various methods for financial analysis, including:

• company_basic_financials(symbol, metric): Get basic financials.
• company_earnings(symbol, limit): Get earnings surprises.
• company_eps_estimates(symbol, freq): Get EPS estimates.
• company_revenue_estimates(symbol, freq): Get revenue estimates.
• financials(symbol, report_type, frequency): Get detailed financials (e.g., 'bs' for balance sheet).
• financials_reported(symbol, freq): Get financials as reported.

# 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'))

# Financials
print(finnhub_client.financials('AAPL', 'bs', 'annual'))

The library supports cryptocurrency and forex markets:

• crypto_exchanges(): List crypto exchanges.
• crypto_symbols(exchange): List symbols for a specific exchange.
• crypto_candles(symbol, resolution, from, to): Get crypto candle data.
• forex_exchanges(): List forex exchanges.
• forex_rates(base): Get forex rates for a base currency.
• forex_symbols(exchange): List forex symbols.
• forex_candles(symbol, resolution, from, to): Get forex candle data.

# Crypto
print(finnhub_client.crypto_exchanges())
print(finnhub_client.crypto_symbols('BINANCE'))
print(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))

# Forex
print(finnhub_client.forex_exchanges())
print(finnhub_client.forex_rates(base='USD'))
print(finnhub_client.forex_symbols('OANDA'))

Retrieve technical analysis data:

• aggregate_indicator(symbol, resolution): Technical indicator data.
• technical_indicator(symbol, resolution, _from, to, indicator, indicator_fields=None): Detailed technical indicator request.
• pattern_recognition(symbol, resolution): Pattern recognition data.
• support_resistance(symbol, resolution): Support and resistance levels.

# Get support and resistance levels
levels = client.support_resistance('AAPL', 'D')

Retrieve earnings data and various analyst estimates:

• company_earnings(symbol, limit=None): Historical earnings.
• company_eps_estimates(symbol, freq=None): EPS estimates.
• company_revenue_estimates(symbol, freq=None): Revenue estimates.
• company_net_income_estimates(symbol, freq=None): Net income estimates.
• company_ebitda_estimates(symbol, freq=None): EBITDA estimates.

# Get EPS estimates
eps_estimates = client.company_eps_estimates('AAPL', freq='quarterly')

Retrieve historical candlestick data (Open, High, Low, Close, Volume) for a symbol. Requires symbol, resolution (e.g., 'D', 'W', 'M'), _from (start timestamp), and to (end timestamp).

# Example: Daily candles for AAPL
candles = client.stock_candles('AAPL', 'D', 1609459200, 1609545600)

The api_key can be accessed or updated dynamically via the api_key property on the Client instance. Updating this property will change the token parameter used in subsequent API requests.

client = Client(api_key='OLD_KEY')
client.api_key = 'NEW_KEY'
print(client.api_key)  # Returns 'NEW_KEY'