Retrieve and analyze Brazilian company financial data with comprehensive quality controls and flexible querying options.

🎯 Core Features

Financial Data Retrieval:

• Complete financial statements (Balance Sheet, Income Statement, Detailed Accounts)
• 40+ automatically calculated financial indicators
• Multi-year historical data
• Original PDF document links

Flexible Querying:

• Full financial data or single indicator extraction
• Year filtering with optimized pricing
• Data availability checks (FREE)
• 🆕 Available accounts inspection - See which fields are available for each year

Data Quality Filters:

• Field completeness validation (minCompleteness)
• Essential field requirements (requireCoreFields)
• Flexible filtering scope (last year, all years, or last N years)

📊 Available Actions

*Credit cost decreases with more years requested (volume discount)

💰 Pricing Details

Full Financial Data:

• All years: 2.5 credits base
• 1 year: 2.125 credits
• 2 years: 2.189 credits
• 3 years: 2.254 credits
• 4 years: 2.322 credits
• 5 years: 2.392 credits
• 6+ years: 2.5 credits

Single Indicator:

• All years: 0.357 credits base
• 1 year: 0.304 credits
• 2 years: 0.313 credits
• 3 years: 0.322 credits
• 4 years: 0.332 credits
• 5 years: 0.342 credits
• 6+ years: 0.357 credits

💡 Tip: Single indicator requests cost ~85% less than full data!

🔍 Quality Filters

Optional parameters to ensure data reliability:

minCompleteness (0.0 to 1.0):

• Defines minimum percentage of filled fields
• Calculated across Balance Sheet, Income Statement, Detailed Accounts, and Financial Indicators (~75 total fields)
• Recommendation: Use max 0.5 (50%) as many indicators require specific data points to be calculated
• Even high-quality statements often have only 40-53% completeness due to missing data for advanced indicators
• Example: 0.5 = At least 50% of all fields must be filled

requireCoreFields (boolean):

• Requires 9 STATIC essential fields: 7 Balance Sheet + 2 Income Statement
• Fixed list - cannot be customized
• Balance Sheet (7): ativoTotal, ativoCirculante, ativoNaoCirculante, passivoTotal, passivoCirculante, passivoNaoCirculante, patrimonioLiquido
• Income Statement (2): receitaLiquida, lucroLiquido
• These are the minimum fields needed for basic financial analysis

qualityFilterScope ("last" | "all" | "lastN"):

• "last": Validates only the most recent year. Returns error 400 if validation fails, otherwise returns all requested years
• "all": Validates all years. Returns only years that pass quality filters
• "lastN": Validates the last N years (requires qualityFilterYears). Returns validated recent years + older years without validation

💳 Credit System

• Volume-based pricing: more years = lower cost per year
• Single indicator extraction saves ~85% credits
• Monthly credit limits per user
• Real-time usage tracking
• Credits charged only for years returned (after quality filtering)

🔐 Authentication

All endpoints use user/password authentication where password can be apikey, apikey2, or apikey3.