Client for the 'AxPrism' Institutional XBRL and Shariah Compliance API


[Up] [Top]

Documentation for package ‘axprism’ version 0.2.0

Help Pages

axprism_batch_metric One metric across multiple tickers (max 20)
axprism_bulk_financials Bulk financials as a CSV string
axprism_bursa_shariah Bursa Malaysia Shariah-compliant list
axprism_bursa_symbols Bursa Malaysia symbols
axprism_calendar Earnings / events calendar for a ticker
axprism_client Create an AxPrism API client
axprism_compare Compare a metric across companies over time
axprism_compliance Shariah compliance verdict for one ticker
axprism_compliance_multi Run all supported Shariah standards at once
axprism_compliance_point_in_time Historical point-in-time compliance verdict
axprism_compliance_trend Compliance ratio trend over N periods
axprism_concept_history Historical values for a single XBRL concept
axprism_disclosures_recent Recent filings for a ticker
axprism_disclosures_search Full-text search across disclosures (SEC EDGAR, ESEF, etc.)
axprism_estimates Analyst consensus, price targets, earnings, and dividends
axprism_exchanges List supported exchanges
axprism_facts Raw XBRL facts for a company
axprism_financials Normalized financial statements (IS / BS / CF / ALL)
axprism_fx_rates FX rates relative to a base currency
axprism_health Public health check
axprism_holders_13f Institutional 13-F holders by CIK
axprism_idx_financials IDX company financials
axprism_idx_symbols Indonesia Stock Exchange (IDX) symbols
axprism_insiders Insider (Form 3/4/5) transactions
axprism_market_cap Rolling-average market capitalization (USD)
axprism_me Account info for the current API key
axprism_news Recent news for a ticker
axprism_portfolio Screen a full portfolio for Shariah compliance and purification
axprism_prices OHLCV price history
axprism_pricing Subscription pricing and entitlements
axprism_profile Company profile, CIK, SIC, exchange, and Shariah activity screen
axprism_purification Purification amount for a single holding (USD)
axprism_request Make a raw request against the AxPrism API
axprism_rulesets List supported Shariah compliance rulesets
axprism_screener Screen tickers by compliance and fundamentals (max 50)
axprism_segments Reported business / geographic segments
axprism_symbols Symbol search / suggestions
axprism_tadawul_financials Tadawul company financials
axprism_tadawul_symbols Tadawul (Saudi) symbols
axprism_text_search Search indexed filing text blocks
axprism_ttm Trailing twelve months income statement
axprism_usage Request usage analytics
axprism_webhooks_create Create a webhook subscription
axprism_webhooks_delete Delete a webhook subscription
axprism_webhooks_events List available webhook event types
axprism_webhooks_list List webhook subscriptions