Documentation
Comprehensive documentation for the TradingView Screener API TypeScript library.
Table of Contents
Getting Started
- Installation - Installation and setup
- Quick Start - Get started in 5 minutes
- Basic Usage - Core concepts and basic examples
Screeners
- Stock Screener - Query stock market data
- Crypto Screener - Query cryptocurrency data
- Forex Screener - Query forex pairs
- Bond Screener - Query bond data
- Futures Screener - Query futures contracts
- Coin Screener - Query coin data
Fields
- Field System - Understanding fields
- Stock Fields - Complete stock field reference
- Crypto Fields - Complete crypto field reference
- Field Search - Finding and filtering fields
- Field Modifiers - Intervals and history
Filtering
- Filter Operations - All comparison operators
- Complex Queries - Multi-condition filtering
- Field Conditions - Building conditions
Advanced
- Streaming Data - Real-time data updates
- Pagination - Working with large result sets
- Sorting - Custom sort orders
- Error Handling - Handling errors gracefully
- Performance Tips - Optimization techniques
Utilities
- Formatting - Number and value formatting
- Beautification - Terminal styling
- Type System - TypeScript types reference
Integration
- MCP Server - Model Context Protocol integration
- Claude Desktop - Using with Claude
- Custom Tools - Building custom tools
Examples
- Value Investing - Find undervalued stocks
- Growth Stocks - High-growth companies
- Technical Analysis - Momentum and indicators
- Dividend Investing - Income strategies
- Crypto Trading - Cryptocurrency screening
- Market Scanning - Daily market scans
API Reference
- BaseScreener - Base screener class
- BaseField - Field class reference
- Filter - Filter system API
- Enums - All enumeration types
- Exceptions - Error classes
Development
- Contributing - How to contribute
- Testing - Running and writing tests
- Architecture - Project structure
Quick Links
Support
- Questions: Open a GitHub Discussion
- Bugs: Report on GitHub Issues
License
MIT License