Skip to main content

Tickersnap is a tool for getting snapshots of stock data from www.tickertape.in

Project description

Tickersnap

Documentation PyPI version Python versions License: Apache 2.0
GitHub Actions Workflow Status Tests Visitors PyPI Total Downloads PyPI Monthly Downloads

Python Library for Indian Stock Market Analysis 📈

| Documentation | Features | Quick Start |

Tickersnap provides streamlined access to comprehensive Indian stock market data from www.tickertape.in, enabling powerful financial analysis, automated screening, and market sentiment tracking.

[!IMPORTANT]

  • This library heavily relies on the (unofficial) public APIs from Tickertape IN.
  • I am not affiliated with Tickertape.in in any way.
  • Tickertape had been my go to for stock analysis tool for like forever!
  • and I am greatful to them for the work they do!

[!WARNING]

  • All data are for informational purposes only and should not be considered as financial advice.
  • Always consult qualified financial advisors before making investment decisions.
  • I am not an expert in finance.
  • I am not responsible for how one uses this library, the consequences, or financial outcomes of using it.

✨ Key Features

  • 📊 Complete Market Coverage - Access 5,000+ stocks and 270+ ETFs from Indian exchanges
  • 🎯 Stock Scorecard Analysis - 6-category evaluation (Performance, Valuation, Growth, Profitability, Entry Point, Red Flags)
  • 📈 Market Mood Index (MMI) - Real-time sentiment tracking with Fear/Greed zones
  • ⚡ High Performance - Concurrent processing with progress tracking for large datasets
  • 🛡️ Robust & Reliable - Comprehensive error handling and extensive test coverage
  • 🔧 Developer Friendly - Clean APIs with intuitive method names and comprehensive documentation

🛠️ Requirements

  • Python 3.10+

🚀 Quick Start

Installation

pip install tickersnap

Basic Usage

from tickersnap.mmi import MarketMoodIndex
from tickersnap.stock import StockScorecard
from tickersnap.lists import Assets

# Check market sentiment
mmi = MarketMoodIndex()
mood = mmi.get_current_mmi()
print(f"Market Mood: {mood.value:.1f} ({mood.zone.value})")

# Analyze a stock
scorecard = StockScorecard()
analysis = scorecard.get_scorecard("TCS")
if analysis.performance:
    print(f"TCS Performance: {analysis.performance.rating.value}")

# Get all stocks
assets = Assets()
all_stocks = assets.get_all_stocks()
print(f"Total stocks available: {len(all_stocks)}")

👉 Complete Quick Start Guide - Learn with real examples!

📦 Core Modules

Module Description Use Case
📋 Assets Complete list of stocks & ETFs Portfolio building, universe selection
📊 Stock Scorecard 6-category stock analysis Investment screening, due diligence
📈 Market Mood Index Sentiment tracking (0-100 scale) Market timing, contrarian investing

👉 see documentation for more details! | MMI | Assets | Stocks |

💡 What You Can Build

  • 📊 Stock Screeners - Find quality stocks automatically
  • 📈 Portfolio Trackers - Monitor your investments daily
  • 🎯 Market Alerts - Get notified of sentiment extremes
  • 🔍 Research Tools - Comprehensive market analysis
  • 🤖 Trading Bots - Automated analysis and signals
  • 🧠 LLM Agents - Build agents to get live financial data

👉 see documentation, every module is filled with usage examples!

📄 License

Licensed under the Apache License 2.0

🤝 Contributing

Contributions are welcome!

(contribution guidelines are coming soon.)


Made with ❤️ for Fin Lovers in India

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tickersnap-0.0.4.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tickersnap-0.0.4-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file tickersnap-0.0.4.tar.gz.

File metadata

  • Download URL: tickersnap-0.0.4.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for tickersnap-0.0.4.tar.gz
Algorithm Hash digest
SHA256 8c4f6f374f3c2c720599d28db5732c70a5c030387c61d62180cb444b7379de5a
MD5 acc2fa1b66a1025a7d4fd8de01c08aca
BLAKE2b-256 2c3679d89dfb3c02d4425f417f0db4969af5cd4057a6e45617207919a1b7a35a

See more details on using hashes here.

File details

Details for the file tickersnap-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: tickersnap-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 25.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for tickersnap-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2db7efa8cc0d4f8a91457fd630ce1091a8dd1ad1b637cf6d6d1860b289ba928a
MD5 7575963cc36427892725bd3f7b787cce
BLAKE2b-256 33120bdfdc2d1939ef35b3002c890aac06bfddbd11699f58b81b1d8e16aedd54

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page