Package: axprism 0.2.0

Marco Corleone

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

Provides an R client for the 'AxPrism' Application Programming Interface (API) (<https://axprism.com>), which serves institutional financial data in the eXtensible Business Reporting Language (XBRL) format together with Shariah compliance screening. Supported compliance rulesets include those of the Accounting and Auditing Organization for Islamic Financial Institutions (AAOIFI), the Morgan Stanley Capital International (MSCI) Islamic methodology, the Dow Jones Islamic Market (DJIM), the Financial Times Stock Exchange (FTSE) and the Saudi Capital Market Authority (CMA). Convenience functions wrap company fundamentals, compliance verdicts and portfolio screening, company profiles, equity screeners, regulatory disclosures and filing text search, and the Tadawul (Saudi Exchange), Bursa Malaysia and Indonesia Stock Exchange (IDX) markets, as well as webhooks and bulk data export. Requests use 'X-API-Key' header authentication, automatic retries with exponential backoff, and a generic request helper that covers all endpoints.

Authors:Marco Corleone [aut, cre]

axprism_0.2.0.tar.gz
axprism_0.2.0.tar.gz(r-4.7-any)axprism_0.2.0.tar.gz(r-4.6-any)
axprism_0.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
axprism/json (API)

# Install 'axprism' in R:
install.packages('axprism', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

On CRAN:

Conda:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

1.70 score 46 exports 8 dependencies

Last updated from:1849732253. Checks:4 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK120
source / vignettesOK219
linux-release-x86_64OK113
wasm-releaseOK88

Exports:axprism_batch_metricaxprism_bulk_financialsaxprism_bursa_shariahaxprism_bursa_symbolsaxprism_calendaraxprism_clientaxprism_compareaxprism_complianceaxprism_compliance_multiaxprism_compliance_point_in_timeaxprism_compliance_trendaxprism_concept_historyaxprism_disclosures_recentaxprism_disclosures_searchaxprism_estimatesaxprism_exchangesaxprism_factsaxprism_financialsaxprism_fx_ratesaxprism_healthaxprism_holders_13faxprism_idx_financialsaxprism_idx_symbolsaxprism_insidersaxprism_market_capaxprism_meaxprism_newsaxprism_portfolioaxprism_pricesaxprism_pricingaxprism_profileaxprism_purificationaxprism_requestaxprism_rulesetsaxprism_screeneraxprism_segmentsaxprism_symbolsaxprism_tadawul_financialsaxprism_tadawul_symbolsaxprism_text_searchaxprism_ttmaxprism_usageaxprism_webhooks_createaxprism_webhooks_deleteaxprism_webhooks_eventsaxprism_webhooks_list

Dependencies:askpasscurlhttrjsonlitemimeopensslR6sys

Readme and manuals

Help Manual

Help pageTopics
One metric across multiple tickers (max 20)axprism_batch_metric
Bulk financials as a CSV stringaxprism_bulk_financials
Bursa Malaysia Shariah-compliant listaxprism_bursa_shariah
Bursa Malaysia symbolsaxprism_bursa_symbols
Earnings / events calendar for a tickeraxprism_calendar
Create an AxPrism API clientaxprism_client
Compare a metric across companies over timeaxprism_compare
Shariah compliance verdict for one tickeraxprism_compliance
Run all supported Shariah standards at onceaxprism_compliance_multi
Historical point-in-time compliance verdictaxprism_compliance_point_in_time
Compliance ratio trend over N periodsaxprism_compliance_trend
Historical values for a single XBRL conceptaxprism_concept_history
Recent filings for a tickeraxprism_disclosures_recent
Full-text search across disclosures (SEC EDGAR, ESEF, etc.)axprism_disclosures_search
Analyst consensus, price targets, earnings, and dividendsaxprism_estimates
List supported exchangesaxprism_exchanges
Raw XBRL facts for a companyaxprism_facts
Normalized financial statements (IS / BS / CF / ALL)axprism_financials
FX rates relative to a base currencyaxprism_fx_rates
Public health checkaxprism_health
Institutional 13-F holders by CIKaxprism_holders_13f
IDX company financialsaxprism_idx_financials
Indonesia Stock Exchange (IDX) symbolsaxprism_idx_symbols
Insider (Form 3/4/5) transactionsaxprism_insiders
Rolling-average market capitalization (USD)axprism_market_cap
Account info for the current API keyaxprism_me
Recent news for a tickeraxprism_news
Screen a full portfolio for Shariah compliance and purificationaxprism_portfolio
OHLCV price historyaxprism_prices
Subscription pricing and entitlementsaxprism_pricing
Company profile, CIK, SIC, exchange, and Shariah activity screenaxprism_profile
Purification amount for a single holding (USD)axprism_purification
Make a raw request against the AxPrism APIaxprism_request
List supported Shariah compliance rulesetsaxprism_rulesets
Screen tickers by compliance and fundamentals (max 50)axprism_screener
Reported business / geographic segmentsaxprism_segments
Symbol search / suggestionsaxprism_symbols
Tadawul company financialsaxprism_tadawul_financials
Tadawul (Saudi) symbolsaxprism_tadawul_symbols
Search indexed filing text blocksaxprism_text_search
Trailing twelve months income statementaxprism_ttm
Request usage analyticsaxprism_usage
Create a webhook subscriptionaxprism_webhooks_create
Delete a webhook subscriptionaxprism_webhooks_delete
List available webhook event typesaxprism_webhooks_events
List webhook subscriptionsaxprism_webhooks_list