getTierLimits

Stock Screening Platform - Frontend API v0.1.0

---

Stock Screening Platform - Frontend API / utils/freemiumConfig / getTierLimits

Function: getTierLimits()

getTierLimits(tier): { maxScreeningResults: 20; dailyScreeningLimit: 10; maxCompareStocks: 2; chartTimeframes: readonly ["1D", "1W", "1M"]; technicalIndicators: 3; canSavePresets: false; canExportResults: false; canViewFinancials: false; canViewAllTechnicals: false; canAddToWatchlist: false; maxWatchlists: 0; maxStocksPerWatchlist: 0; } | { maxScreeningResults: -1; dailyScreeningLimit: -1; maxCompareStocks: 5; chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y"]; technicalIndicators: -1; canSavePresets: true; canExportResults: true; canViewFinancials: true; canViewAllTechnicals: true; canAddToWatchlist: true; maxWatchlists: 10; maxStocksPerWatchlist: 100; } | { maxScreeningResults: -1; dailyScreeningLimit: -1; maxCompareStocks: 10; chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y", "5Y"]; technicalIndicators: -1; canSavePresets: true; canExportResults: true; canViewFinancials: true; canViewAllTechnicals: true; canAddToWatchlist: true; maxWatchlists: -1; maxStocksPerWatchlist: -1; aiRecommendations: true; apiAccess: true; priceAlerts: true; }

Defined in: src/utils/freemiumConfig.ts:136

Get limits for a specific tier.

Parameters

tier

FreemiumTier

The freemium tier

Returns

{ maxScreeningResults: 20; dailyScreeningLimit: 10; maxCompareStocks: 2; chartTimeframes: readonly ["1D", "1W", "1M"]; technicalIndicators: 3; canSavePresets: false; canExportResults: false; canViewFinancials: false; canViewAllTechnicals: false; canAddToWatchlist: false; maxWatchlists: 0; maxStocksPerWatchlist: 0; }

maxScreeningResults

readonly maxScreeningResults: 20 = 20

Maximum number of results shown in screening (vs. full results)

dailyScreeningLimit

readonly dailyScreeningLimit: 10 = 10

Daily limit for screening operations

maxCompareStocks

readonly maxCompareStocks: 2 = 2

Maximum number of stocks that can be compared simultaneously

chartTimeframes

readonly chartTimeframes: readonly ["1D", "1W", "1M"]

Available chart timeframes for price charts

technicalIndicators

readonly technicalIndicators: 3 = 3

Number of technical indicators available

canSavePresets

readonly canSavePresets: false = false

Can save filter presets

canExportResults

readonly canExportResults: false = false

Can export results to CSV

canViewFinancials

readonly canViewFinancials: false = false

Can view financial statements

canViewAllTechnicals

readonly canViewAllTechnicals: false = false

Can view all technical indicators

canAddToWatchlist

readonly canAddToWatchlist: false = false

Can add stocks to watchlist

maxWatchlists

readonly maxWatchlists: 0 = 0

Maximum number of watchlists

maxStocksPerWatchlist

readonly maxStocksPerWatchlist: 0 = 0

Maximum stocks per watchlist

{ maxScreeningResults: -1; dailyScreeningLimit: -1; maxCompareStocks: 5; chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y"]; technicalIndicators: -1; canSavePresets: true; canExportResults: true; canViewFinancials: true; canViewAllTechnicals: true; canAddToWatchlist: true; maxWatchlists: 10; maxStocksPerWatchlist: 100; }

maxScreeningResults

readonly maxScreeningResults: -1 = -1

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

dailyScreeningLimit

readonly dailyScreeningLimit: -1 = -1

Daily limit for screening operations (-1 = unlimited)

maxCompareStocks

readonly maxCompareStocks: 5 = 5

Maximum number of stocks that can be compared simultaneously

chartTimeframes

readonly chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y"]

Available chart timeframes for price charts

technicalIndicators

readonly technicalIndicators: -1 = -1

Number of technical indicators available (-1 = all)

canSavePresets

readonly canSavePresets: true = true

Can save filter presets

canExportResults

readonly canExportResults: true = true

Can export results to CSV

canViewFinancials

readonly canViewFinancials: true = true

Can view financial statements

canViewAllTechnicals

readonly canViewAllTechnicals: true = true

Can view all technical indicators

canAddToWatchlist

readonly canAddToWatchlist: true = true

Can add stocks to watchlist

maxWatchlists

readonly maxWatchlists: 10 = 10

Maximum number of watchlists

maxStocksPerWatchlist

readonly maxStocksPerWatchlist: 100 = 100

Maximum stocks per watchlist

{ maxScreeningResults: -1; dailyScreeningLimit: -1; maxCompareStocks: 10; chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y", "5Y"]; technicalIndicators: -1; canSavePresets: true; canExportResults: true; canViewFinancials: true; canViewAllTechnicals: true; canAddToWatchlist: true; maxWatchlists: -1; maxStocksPerWatchlist: -1; aiRecommendations: true; apiAccess: true; priceAlerts: true; }

maxScreeningResults

readonly maxScreeningResults: -1 = -1

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

dailyScreeningLimit

readonly dailyScreeningLimit: -1 = -1

Daily limit for screening operations (-1 = unlimited)

maxCompareStocks

readonly maxCompareStocks: 10 = 10

Maximum number of stocks that can be compared simultaneously

chartTimeframes

readonly chartTimeframes: readonly ["1D", "1W", "1M", "3M", "6M", "1Y", "3Y", "5Y"]

Available chart timeframes for price charts

technicalIndicators

readonly technicalIndicators: -1 = -1

Number of technical indicators available (-1 = all)

canSavePresets

readonly canSavePresets: true = true

Can save filter presets

canExportResults

readonly canExportResults: true = true

Can export results to CSV

canViewFinancials

readonly canViewFinancials: true = true

Can view financial statements

canViewAllTechnicals

readonly canViewAllTechnicals: true = true

Can view all technical indicators

canAddToWatchlist

readonly canAddToWatchlist: true = true

Can add stocks to watchlist

maxWatchlists

readonly maxWatchlists: -1 = -1

Maximum number of watchlists (-1 = unlimited)

maxStocksPerWatchlist

readonly maxStocksPerWatchlist: -1 = -1

Maximum stocks per watchlist (-1 = unlimited)

aiRecommendations

readonly aiRecommendations: true = true

AI-powered stock recommendations

apiAccess

readonly apiAccess: true = true

API access enabled

priceAlerts

readonly priceAlerts: true = true

Price alerts enabled

Configuration object for the specified tier

Example

const limits = getTierLimits('free')
console.log(limits.maxScreeningResults) // -1 (unlimited)