API Reference¶
Complete API documentation for FinWiz crews, tools, and schemas.
Crew APIs¶
- Crews - Crew configuration and usage
- Tools - Tool reference and parameters
- Schemas - Data models and validation
Quick Links¶
API Categories¶
Analysis Crews¶
Specialized crews for different asset types:
- Stock Crew API - Stock analysis and fundamental research
- ETF Crew API - Exchange-traded fund analysis
- Crypto Crew API - Cryptocurrency analysis
- Portfolio Rebalancing API - Portfolio optimization and rebalancing
Tool APIs¶
Essential tools for financial analysis:
- Market Screening Tool - Filter and screen investment opportunities
- Sentiment Analysis Tool - News and social sentiment analysis
- Quantitative Analysis Tool - Technical and quantitative metrics
- Backtesting Tool - Strategy backtesting and validation
Schema APIs¶
Data models and validation schemas:
- Portfolio Schemas - Portfolio structure and holdings
- Analysis Result Schemas - Analysis output formats
- Rebalancing Schemas - Rebalancing recommendations
- Discovery Schemas - A+ investment discovery results
Getting Started¶
New to the FinWiz API? Check out these resources:
API Design Principles¶
FinWiz APIs follow these principles:
- Pydantic-First: All data validated with strict schemas
- Type-Safe: Full type hints for IDE autocomplete
- Consistent: Uniform interfaces across all crews
- Documented: Comprehensive docstrings and examples
For detailed API documentation, see the sections above or the complete API reference.