Skip to content

API Reference

Complete API documentation for FinWiz financial analysis platform.

Quick Navigation

Analysis Crews

FinWiz provides specialized crews for different asset types:

Stock Analysis

  • StockCrew - Fundamental and technical stock analysis
  • See Stock Crew API for details

ETF Analysis

  • ETFCrew - Exchange-traded fund analysis
  • See ETF Crew API for details

Cryptocurrency Analysis

  • CryptoCrew - Cryptocurrency and digital asset analysis
  • See Crypto Crew API for details

Portfolio Analysis

  • PortfolioReviewCrew - Portfolio holdings analysis and recommendations
  • PortfolioRebalancingCrew - Portfolio optimization and rebalancing
  • See Portfolio Crews for details

Discovery

  • InvestmentDiscoveryCrew - A+ investment opportunity discovery
  • See Discovery Crew API for details

Tool Reference

Essential tools for financial analysis:

  • Market Data Tools - Real-time and historical market data
  • Sentiment Analysis - News and social media sentiment
  • Quantitative Analysis - Technical indicators and metrics
  • Backtesting - Strategy testing and validation
  • Risk Assessment - Portfolio risk analysis

See Tool APIs for complete documentation.

Schema Reference

Pydantic data models for type-safe analysis:

  • CrewExportSchemas - Output schemas for each crew
  • PortfolioSchemas - Portfolio structure and holdings
  • AnalysisSchemas - Analysis results and recommendations
  • ValidationSchemas - Data validation models

See Schema APIs for complete documentation.

Flow Reference

CrewAI Flow orchestration:

  • FinwizFlow - Main workflow orchestration
  • State Management - Pydantic-based flow state
  • Flow Listeners - Event-driven workflow steps

See Flow APIs for complete documentation.

Configuration Reference

System and crew configuration:

  • Environment Variables - API keys and settings
  • Agent Configuration - Agent behavior and parameters
  • Task Configuration - Task definitions and dependencies
  • Tool Configuration - Tool initialization and settings

See Configuration Reference for complete documentation.

Getting Started

New to the FinWiz API? Check out these resources:

API Examples

Running Stock Analysis

Python
from finwiz.crews.stock_crew import StockCrew

crew = StockCrew()
result = crew.crew().kickoff(inputs={"ticker": "AAPL"})
print(result.raw)

Portfolio Review

Python
from finwiz.flows.flow_orchestrator import FinwizFlow

flow = FinwizFlow()
result = flow.kickoff()

See Also