axprism_screener: Screen tickers by compliance and fundamentals (max 50)

View source: R/axprism.R

axprism_screenerR Documentation

Screen tickers by compliance and fundamentals (max 50)

Description

Screen tickers by compliance and fundamentals (max 50)

Usage

axprism_screener(
  client,
  tickers,
  verdict = NULL,
  ruleset = "aaoifi",
  period = "annual",
  debt_ratio_max = NULL,
  income_ratio_max = NULL,
  market_cap_min = NULL,
  market_cap_max = NULL,
  limit = 50
)

Arguments

client

An axprism_client.

tickers

Character vector of tickers.

verdict

Optional verdict filter ("halal"/"haram"/"inconclusive").

ruleset

Compliance ruleset (default "aaoifi").

period

"annual" or "quarterly".

debt_ratio_max

Optional max debt ratio.

income_ratio_max

Optional max non-permissible income ratio.

market_cap_min

Optional minimum market cap (USD).

market_cap_max

Optional maximum market cap (USD).

limit

Max results (default 50).

Value

Parsed API response as a named list.

Examples

client <- axprism_client(api_key = "demo-key")
## Not run: 
axprism_screener(client, c("AAPL", "MSFT"))

## End(Not run)

axprism documentation built on July 8, 2026, 9:07 a.m.