Skip to main content

FreemiumLimits

Stock Screening Platform - Frontend API v0.1.0

Stock Screening Platform - Frontend API / hooks/useFreemiumAccess / FreemiumLimits

Interface: FreemiumLimits

Defined in: src/hooks/useFreemiumAccess.ts:24

Freemium access limits and permissions.

Contains all feature flags and usage limits for the current user's tier.

Properties​

isAuthenticated​

isAuthenticated: boolean

Defined in: src/hooks/useFreemiumAccess.ts:26

Whether user is authenticated

tier​

tier: FreemiumTier

Defined in: src/hooks/useFreemiumAccess.ts:29

User's freemium tier

maxScreeningResults​

maxScreeningResults: number

Defined in: src/hooks/useFreemiumAccess.ts:33

Maximum number of results to show in screening (-1 = unlimited)

dailyScreeningLimit​

dailyScreeningLimit: number

Defined in: src/hooks/useFreemiumAccess.ts:35

Daily limit for screening operations (-1 = unlimited)

screeningsToday​

screeningsToday: number

Defined in: src/hooks/useFreemiumAccess.ts:37

Number of screenings performed today

screeningsRemaining​

screeningsRemaining: number

Defined in: src/hooks/useFreemiumAccess.ts:39

Number of screenings remaining today

canSavePresets​

canSavePresets: boolean

Defined in: src/hooks/useFreemiumAccess.ts:41

Whether user can save filter presets

canExportResults​

canExportResults: boolean

Defined in: src/hooks/useFreemiumAccess.ts:43

Whether user can export results to CSV

canViewFinancials​

canViewFinancials: boolean

Defined in: src/hooks/useFreemiumAccess.ts:47

Whether user can view financial statements

canViewAllTechnicals​

canViewAllTechnicals: boolean

Defined in: src/hooks/useFreemiumAccess.ts:49

Whether user can view all technical indicators

technicalIndicators​

technicalIndicators: number

Defined in: src/hooks/useFreemiumAccess.ts:51

Number of technical indicators available

canAddToWatchlist​

canAddToWatchlist: boolean

Defined in: src/hooks/useFreemiumAccess.ts:53

Whether user can add stocks to watchlist

maxCompareStocks​

maxCompareStocks: number

Defined in: src/hooks/useFreemiumAccess.ts:57

Maximum number of stocks that can be compared

maxWatchlists​

maxWatchlists: number

Defined in: src/hooks/useFreemiumAccess.ts:61

Maximum number of watchlists user can create

maxStocksPerWatchlist​

maxStocksPerWatchlist: number

Defined in: src/hooks/useFreemiumAccess.ts:63

Maximum stocks per watchlist

chartTimeframes​

chartTimeframes: readonly string[]

Defined in: src/hooks/useFreemiumAccess.ts:67

Available chart timeframes

aiRecommendations?​

optional aiRecommendations: boolean

Defined in: src/hooks/useFreemiumAccess.ts:71

Whether AI recommendations are available

apiAccess?​

optional apiAccess: boolean

Defined in: src/hooks/useFreemiumAccess.ts:73

Whether API access is enabled

priceAlerts?​

optional priceAlerts: boolean

Defined in: src/hooks/useFreemiumAccess.ts:75

Whether price alerts are available