TickerTape Client (Unofficial SDK)

An unofficial, asynchronous, typed Python SDK and client for TickerTape featuring persistent caching, Next.js hydration payload extraction, and an SQLite-backed ISIN lookup engine.

[!NOTE] Disclaimer: tickertape-client is an unofficial community-maintained SDK/client and is not affiliated with, endorsed by, sponsored by, or associated with TickerTape or its parent companies. All product names, logos, and brands are property of their respective owners.

---

Architecture Overview

flowchart TD
    Client["TickerTapeClient\n(Async HTTP & Connection Pool)"]

    subgraph Storage ["Persistent Cache Layer (.cache/tickertape)"]
        DiskCache["SitemapCacheManager\n(JSON Cache)"]
        SQLiteDB[("ISINLookupTable\n(SQLite Database)")]
    end

    subgraph Resources ["Domain Resources"]
        SR["SitemapResource\n(XML urlset & sitemapindex)"]
        MFR["MutualFundsResource\n(Mutual Fund Operations)"]
    end

    subgraph LookupEngine ["ISIN Lookup Engine"]
        Resolver["ISINResolver\n(Targeted Fuzzy Matcher)"]
        Indexer["ISINIndexer\n(Concurrent Bulk Crawler)"]
    end

    subgraph Parsers ["Extensible Parser Registry"]
        SP["SitemapParser"]
        MFP["MFParser\n(__NEXT_DATA__ SSR extractor)"]
        CustomP["Custom Parsers\n(BaseParser interface)"]
    end

    Client --> SR
    Client --> MFR
    Client --> DiskCache

    SR --> SP
    SR --> DiskCache

    MFR --> MFP
    MFR --> LookupEngine

    Resolver --> SQLiteDB
    Resolver --> SR
    Indexer --> SQLiteDB
    Indexer --> MFR

---

Key Capabilities

⚡ Async & High Performance

Built natively on httpx and asyncio for non-blocking HTTP requests, connection pooling, and concurrent crawling with fine-grained rate limiting.

🗺️ Sitemap Discovery & Persistent Caching

Automatically fetches and parses both standard sitemaps (<urlset>) and sitemap indexes (<sitemapindex>), atomically persisting parsed URLs to disk as JSON for instant subsequent loads.

📊 Next.js Hydration Scraping

Parses server-side rendered (SSR) Next.js payloads (<script id="__NEXT_DATA__">) into strongly typed Pydantic v2 models, unlocking:

• Latest NAV & 1-day percentage change
• Expense ratios, total AUM, and portfolio manager details
• Multi-dimensional scorecard ratings (Performance, Risk, Cost, Composition, Red Flags)
• Full benchmark indices and regulatory CAMS/RTA codes

🔍 SQLite ISIN Engine & Peer Discovery

Maps Indian mutual fund ISINs (e.g. INF966L01721) to TickerTape slugs and taxonomy:

• Targeted Fuzzy Resolver: Locates and verifies unindexed funds on demand using scheme name hints.
• Peer Clustering: Query peer mutual funds by sector, subsector, plan (Direct/Regular), and option (Growth/IDCW).
• Resumable Bulk Indexing: Asynchronously index thousands of schemes with progress tracking callbacks and export the results to JSON or CSV.

🔌 Extensible Design

Easily register custom parsers for new asset types or endpoints using the BaseParser abstract interface and register_parser.

---

Quick Example

import asyncio
from tickertape import TickerTapeClient

async def main():
    async with TickerTapeClient() as client:
        # Fetch fund by slug or MFID
        fund = await client.mf.get("quant-infrastructure-fund-M_QUNG")
        print(f"Fund: {fund.name} | ISIN: {fund.isin} | NAV: INR {fund.nav}")

        # Resolve an ISIN directly
        resolved = await client.mf.get_by_isin(
            isin="INF966L01721",
            hint_name="Quant Infrastructure Fund",
        )
        if resolved:
            print(f"Resolved from ISIN: {resolved.name}")

        # Find peers in the same category
        peers = client.mf.get_peers("INF966L01721", limit=5)
        for peer in peers:
            print(f"Peer: {peer.name} (ISIN: {peer.isin})")

if __name__ == "__main__":
    asyncio.run(main())

---

Documentation Roadmap

• Installation: Set up tickertape-client with pip or uv.
• Quickstart: Jump right into working code examples.
• User Guides: Step-by-step guides covering every feature in depth.
• API Reference: Complete autogenerated class and method documentation.
• Contributing: Development workflow, testing, and guidelines.

---

Disclaimer

This software is an unofficial, community-driven client library. It is neither created, maintained, endorsed, nor supported by TickerTape or its affiliates. Use this tool responsibly, in compliance with all applicable terms of service and rate limits.