lukhed-stocks 0.0.1

A collection of stock analysis functions and api wrappers

lukhed_stocks

A collection of stocks analysis utility functions and API wrappers built with personal use in mind. Basic functionality is available now, and this repo is in development. Please note that you are responsible for how you access and use the data. See the responsible data usage section for more info.

Installation

pip install lukhed-stocks

TOC

• Available Functions
• Available Wrappers
• Get Exchange and Index Data
  • Tickers Import
  • Get Exchange Data Functions
  • Get Index Data Functions
• CAT Wrapper
• Wikipediia Stocks
• Responsible Data Usage
  • CAT Data Usage
  • Wikipedia Data Usage
  • Tradingview Data Usage

Available Functions

• Get Exchange & Index Data - Utilizing various sources (free or with API key) to provide ticker data for exchanges.

Available Wrappers

• CAT Wrapper - Conolidated Audit Trail (CAT) for exchange data provided by CAT Webpage
• Wikipedia Stocks - For obtaining various stock data from Wikipedia (various pages)

Get Exchange and Index Data

Tickers Import

from lukhed_stocks import tickers

Get Exchange Data Functions

Provides a list of stock data for the given exchange. Each function can optionally be called with 'tickers_only' parameter to return a list of strings only. These functions utilize CAT data by default and do not require an API key.

nasdaq = tickers.get_nasdaq_stocks()
nyse = tickers.get_nyse_stocks(tickers_only=True)
otc = tickers.get_otc_stocks()
iex = tickers.get_iex_stocks(tickers_only=True)

Function	Default Source
tickers.get_nasdaq_stocks	CAT
tickers.get_nyse_stocks	CAT
tickers.get_otc_stocks	CAT
tickers.get_iex_stocks	CAT

Get Index Data Functions

Provides a list of stock data for the given index. Each function can optionally be called with 'tickers_only' parameter to return a list of strings only. The default source for each function does not require an API key.

sp500 = tickers.get_sp500_stocks()
djia = tickers.get_dow_stocks(tickers_only=True)
otc = tickers.get_russell2000_stocks()

Function	Default Source
tickers.get_sp500_stocks	Wikipedia
tickers.get_dow_stocks	Wikipedia
tickers.get_russell2000_stocks	TradingView

CAT Wrapper

Documentation coming soon.

Wikipediia Stocks

Documentation coming soon.

Responsible Data Usage

• Each method or wrapper in the documentation lists the source that is utilized by default
• Below is information related to data retrieval and usage for each source

CAT Data Usage

CAT Data is pulled from this page. They provide a legal notice here.

Wikipedia Data Usage

Wikipedia content is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. For more details on the terms of use, please refer to the Wikimedia Foundation's Terms of Use.

Tradingview Data Usage

I am currently trying to remove trading view as a source, as their policy is restrictive and confusing. Please read trading view policies here: 'https://www.tradingview.com/policies/