API
This page list all user’s APIs of msfinance
- class msfinance.stocks.Stock(debug=False, browser='chrome', database='msfinance.db3', session_factory=None, proxy=None, driver_type='uc')
Get stock financials statements and key metrics statistics
- get_balance_sheet_statement(ticker, exchange, period='Annual', stage='Restated', update=False)
Get balance sheet statement of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
period – Period of statement, which can be ‘Annual’(default), ‘Quarterly’
stage – Stage of statement, which can be ‘As Originally Reported’, ‘Restated’(default)
- Returns:
DataFrame of balance sheet statement
- get_cash_flow(ticker, exchange, update=False)
Get cash flow statistics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
- Returns:
DataFrame of statistics
- get_cash_flow_statement(ticker, exchange, period='Annual', stage='Restated', update=False)
Get cash flow statement of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
period – Period of statement, which can be ‘Annual’(default), ‘Quarterly’
stage – Stage of statement, which can be ‘As Originally Reported’, ‘Restated’(default)
- Returns:
DataFrame of cash flow statement
- get_financial_health(ticker, exchange, update=False)
Get financial health statistics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
- Returns:
DataFrame of statistics
- get_financial_summary(ticker, exchange, update=False)
Get financial summary statistics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
update – Force update data from website
- Returns:
DataFrame of statistics
- get_financials(ticker, exchange, period='Annual', stage='As Originally Reported', update=False)
Get all financials statements of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
period – Period of statement, which can be ‘Annual’(default), ‘Quarterly’
stage – Stage of statement, which can be ‘As Originally Reported’(default), ‘Restated’
- Returns:
DataFrame list of financials statements
- get_growth(ticker, exchange, update=False)
Get growth statistics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
update – Force update data from website
- Returns:
DataFrame of statistics
- get_hsi_tickers()
Get ticker of Hang Seng Index
- Returns:
List of ticker with 5-digit number string
- get_income_statement(ticker, exchange, period='Annual', stage='Restated', update=False)
Get income statement of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
period – Period of statement, which can be ‘Annual’(default), ‘Quarterly’
stage – Stage of statement, which can be ‘As Originally Reported’, ‘Restated’(default)
- Returns:
DataFrame of income statement
- get_key_metrics(ticker, exchange, update=False)
Get all key metrics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
- Returns:
DataFrame list of statistics
- get_profitability_and_efficiency(ticker, exchange, update=False)
Get profitability and efficiency statistics of stock
- Parameters:
ticker – Stock symbol
exchange – Exchange name
- Returns:
DataFrame of statistics
- get_sp500_tickers()
Get tickers of SP500
- Returns:
List of ticker names
- get_xase_tickers()
Get tickers of AMEX
- Returns:
List of ticker names in AMEX
- get_xnas_tickers()
Get tickers of NASDAQ
- Returns:
List of ticker names in NASDAQ
- get_xnys_tickers()
Get tickers of NYSE
- Returns:
List of ticker names in NYSE