axprism_portfolio: Screen a full portfolio for Shariah compliance and...

In axprism: Client for the 'AxPrism' Institutional XBRL and Shariah Compliance API

Screen a full portfolio for Shariah compliance and purification

Description

Screen a full portfolio for Shariah compliance and purification

Usage

axprism_portfolio(
  client,
  items,
  ruleset = "aaoifi",
  period = "annual",
  include_purification = TRUE
)

Arguments

client	An axprism_client.
items	List of holdings (each a list with ticker, optional weight, shares, dividend_per_share).
ruleset	Compliance ruleset (default "aaoifi").
period	"annual" or "quarterly".
include_purification	Compute purification when TRUE.

Value

Parsed API response as a named list.

Examples

client <- axprism_client(api_key = "demo-key")
## Not run: 
axprism_portfolio(client, list(list(ticker = "AAPL", shares = 100)))

## End(Not run)

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