| Title: | Client for the 'AxPrism' Institutional XBRL and Shariah Compliance API |
|---|---|
| Description: | 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] |
| Maintainer: | Marco Corleone <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.2.0 |
| Built: | 2026-07-02 21:21:05 UTC |
| Source: | https://github.com/cran/axprism |
One metric across multiple tickers (max 20)
axprism_batch_metric( client, tickers, metric, period = "annual", currency = "USD", years = 5 )axprism_batch_metric( client, tickers, metric, period = "annual", currency = "USD", years = 5 )
client |
An |
tickers |
Character vector of tickers. |
metric |
Metric key, e.g. "ax:Revenue". |
period |
"annual" or "quarterly". |
currency |
Reporting currency (default "USD"). |
years |
Number of years (default 5). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_batch_metric(client, c("AAPL", "MSFT"), "ax:Revenue") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_batch_metric(client, c("AAPL", "MSFT"), "ax:Revenue") ## End(Not run)
Bulk financials as a CSV string
axprism_bulk_financials(client, ticker, statement = "IS", period = "annual")axprism_bulk_financials(client, ticker, statement = "IS", period = "annual")
client |
An |
ticker |
Ticker symbol. |
statement |
"IS", "BS", or "CF". |
period |
"annual" or "quarterly". |
A character scalar containing CSV text.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bulk_financials(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bulk_financials(client, "AAPL") ## End(Not run)
Bursa Malaysia Shariah-compliant list
axprism_bursa_shariah(client)axprism_bursa_shariah(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bursa_shariah(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bursa_shariah(client) ## End(Not run)
Bursa Malaysia symbols
axprism_bursa_symbols(client, limit = 200)axprism_bursa_symbols(client, limit = 200)
client |
An |
limit |
Max symbols (default 200). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bursa_symbols(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_bursa_symbols(client) ## End(Not run)
Earnings / events calendar for a ticker
axprism_calendar(client, ticker)axprism_calendar(client, ticker)
client |
An |
ticker |
Ticker symbol. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_calendar(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_calendar(client, "AAPL") ## End(Not run)
Create an AxPrism API client
axprism_client( api_key = NULL, base_url = "https://axprism.com", timeout_s = 30, max_retries = 3, backoff_s = 0.5 )axprism_client( api_key = NULL, base_url = "https://axprism.com", timeout_s = 30, max_retries = 3, backoff_s = 0.5 )
api_key |
Your AxPrism API key ( |
base_url |
API base URL. Defaults to |
timeout_s |
Request timeout in seconds (default 30). |
max_retries |
Max retries on 429 / 5xx (default 3). |
backoff_s |
Base seconds for exponential backoff (default 0.5). |
An object of class axprism_client.
# Constructing a client is offline and requires no network access. client <- axprism_client(api_key = "demo-key") inherits(client, "axprism_client") client$base_url # Trailing slashes in the base URL are normalized away. axprism_client(api_key = "k", base_url = "https://axprism.com/")$base_url ## Not run: # A live call additionally needs a real API key and network access. client <- axprism_client(api_key = "axmd_demo_try_axprism_2024") axprism_compliance(client, "AAPL") ## End(Not run)# Constructing a client is offline and requires no network access. client <- axprism_client(api_key = "demo-key") inherits(client, "axprism_client") client$base_url # Trailing slashes in the base URL are normalized away. axprism_client(api_key = "k", base_url = "https://axprism.com/")$base_url ## Not run: # A live call additionally needs a real API key and network access. client <- axprism_client(api_key = "axmd_demo_try_axprism_2024") axprism_compliance(client, "AAPL") ## End(Not run)
Compare a metric across companies over time
axprism_compare( client, tickers, metric = "ax:Revenue", period = "annual", limit_periods = 8, currency = "USD" )axprism_compare( client, tickers, metric = "ax:Revenue", period = "annual", limit_periods = 8, currency = "USD" )
client |
An |
tickers |
Character vector of tickers. |
metric |
Metric key (default "ax:Revenue"). |
period |
"annual" or "quarterly". |
limit_periods |
Number of periods (default 8). |
currency |
Reporting currency (default "USD"). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compare(client, c("AAPL", "MSFT")) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compare(client, c("AAPL", "MSFT")) ## End(Not run)
Shariah compliance verdict for one ticker
axprism_compliance( client, ticker, standard = "aaoifi", period = "annual", as_of = NULL )axprism_compliance( client, ticker, standard = "aaoifi", period = "annual", as_of = NULL )
client |
An |
ticker |
Ticker symbol. |
standard |
"aaoifi", "msci", "dji", "ftse", or "saudi". |
period |
"annual" or "quarterly". |
as_of |
Optional ISO date for point-in-time context. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance(client, "AAPL") ## End(Not run)
Run all supported Shariah standards at once
axprism_compliance_multi(client, ticker, period = "annual")axprism_compliance_multi(client, ticker, period = "annual")
client |
An |
ticker |
Ticker symbol. |
period |
"annual" or "quarterly". |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_multi(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_multi(client, "AAPL") ## End(Not run)
Historical point-in-time compliance verdict
axprism_compliance_point_in_time(client, ticker, as_of, standard = "aaoifi")axprism_compliance_point_in_time(client, ticker, as_of, standard = "aaoifi")
client |
An |
ticker |
Ticker symbol. |
as_of |
ISO date ("YYYY-MM-DD"). |
standard |
Compliance standard (default "aaoifi"). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_point_in_time(client, "AAPL", as_of = "2023-12-31") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_point_in_time(client, "AAPL", as_of = "2023-12-31") ## End(Not run)
Compliance ratio trend over N periods
axprism_compliance_trend(client, ticker, periods = 8)axprism_compliance_trend(client, ticker, periods = 8)
client |
An |
ticker |
Ticker symbol. |
periods |
Number of periods (default 8). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_trend(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_compliance_trend(client, "AAPL") ## End(Not run)
Historical values for a single XBRL concept
axprism_concept_history(client, ticker, concept, limit = 20)axprism_concept_history(client, ticker, concept, limit = 20)
client |
An |
ticker |
Ticker symbol. |
concept |
XBRL concept tag. |
limit |
Max periods (default 20). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_concept_history(client, "AAPL", "Revenues") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_concept_history(client, "AAPL", "Revenues") ## End(Not run)
Recent filings for a ticker
axprism_disclosures_recent(client, ticker, limit = 20)axprism_disclosures_recent(client, ticker, limit = 20)
client |
An |
ticker |
Ticker symbol. |
limit |
Max filings (default 20). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_disclosures_recent(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_disclosures_recent(client, "AAPL") ## End(Not run)
Full-text search across disclosures (SEC EDGAR, ESEF, etc.)
axprism_disclosures_search(client, q, ticker = NULL, forms = NULL, limit = 20)axprism_disclosures_search(client, q, ticker = NULL, forms = NULL, limit = 20)
client |
An |
q |
Query string. |
ticker |
Optional ticker filter. |
forms |
Optional character vector of form types. |
limit |
Max hits (default 20). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_disclosures_search(client, "revenue recognition") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_disclosures_search(client, "revenue recognition") ## End(Not run)
Analyst consensus, price targets, earnings, and dividends
axprism_estimates(client, ticker)axprism_estimates(client, ticker)
client |
An |
ticker |
Ticker symbol. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_estimates(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_estimates(client, "AAPL") ## End(Not run)
List supported exchanges
axprism_exchanges(client)axprism_exchanges(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_exchanges(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_exchanges(client) ## End(Not run)
Raw XBRL facts for a company
axprism_facts(client, ticker, concept = NULL, limit = 500)axprism_facts(client, ticker, concept = NULL, limit = 500)
client |
An |
ticker |
Ticker symbol. |
concept |
Optional XBRL concept filter. |
limit |
Max facts (default 500). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_facts(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_facts(client, "AAPL") ## End(Not run)
Normalized financial statements (IS / BS / CF / ALL)
axprism_financials( client, ticker, statement = "IS", period = "annual", currency = "NATIVE", history = "latest", as_reported = FALSE )axprism_financials( client, ticker, statement = "IS", period = "annual", currency = "NATIVE", history = "latest", as_reported = FALSE )
client |
An |
ticker |
Ticker symbol. |
statement |
"IS", "BS", "CF", or "ALL". |
period |
"annual", "quarterly", or "ttm". |
currency |
"NATIVE", "USD", or any ISO 4217 code. |
history |
"latest" or "all". |
as_reported |
Return raw un-normalized XBRL when TRUE. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_financials(client, "AAPL", statement = "IS") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_financials(client, "AAPL", statement = "IS") ## End(Not run)
FX rates relative to a base currency
axprism_fx_rates(client, base = "USD", symbols = NULL)axprism_fx_rates(client, base = "USD", symbols = NULL)
client |
An |
base |
Base currency (default "USD"). |
symbols |
Optional character vector of target currencies. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_fx_rates(client, "USD", c("EUR", "GBP")) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_fx_rates(client, "USD", c("EUR", "GBP")) ## End(Not run)
Public health check
axprism_health(client)axprism_health(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_health(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_health(client) ## End(Not run)
Institutional 13-F holders by CIK
axprism_holders_13f(client, cik, limit = 1)axprism_holders_13f(client, cik, limit = 1)
client |
An |
cik |
Central Index Key. |
limit |
Max records (default 1). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_holders_13f(client, "0000320193") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_holders_13f(client, "0000320193") ## End(Not run)
IDX company financials
axprism_idx_financials(client, symbol, period = "annual")axprism_idx_financials(client, symbol, period = "annual")
client |
An |
symbol |
IDX symbol. |
period |
"annual" or "quarterly". |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_idx_financials(client, "BBCA") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_idx_financials(client, "BBCA") ## End(Not run)
Indonesia Stock Exchange (IDX) symbols
axprism_idx_symbols(client, limit = 200)axprism_idx_symbols(client, limit = 200)
client |
An |
limit |
Max symbols (default 200). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_idx_symbols(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_idx_symbols(client) ## End(Not run)
Insider (Form 3/4/5) transactions
axprism_insiders(client, ticker, limit = 25)axprism_insiders(client, ticker, limit = 25)
client |
An |
ticker |
Ticker symbol. |
limit |
Max records (default 25). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_insiders(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_insiders(client, "AAPL") ## End(Not run)
Rolling-average market capitalization (USD)
axprism_market_cap(client, ticker, months = 36)axprism_market_cap(client, ticker, months = 36)
client |
An |
ticker |
Ticker symbol. |
months |
Averaging window in months (default 36). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_market_cap(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_market_cap(client, "AAPL") ## End(Not run)
Account info for the current API key
axprism_me(client)axprism_me(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_me(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_me(client) ## End(Not run)
Recent news for a ticker
axprism_news(client, ticker, limit = 25)axprism_news(client, ticker, limit = 25)
client |
An |
ticker |
Ticker symbol. |
limit |
Max items (default 25). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_news(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_news(client, "AAPL") ## End(Not run)
Screen a full portfolio for Shariah compliance and purification
axprism_portfolio( client, items, ruleset = "aaoifi", period = "annual", include_purification = TRUE )axprism_portfolio( client, items, ruleset = "aaoifi", period = "annual", include_purification = TRUE )
client |
An |
items |
List of holdings (each a list with |
ruleset |
Compliance ruleset (default "aaoifi"). |
period |
"annual" or "quarterly". |
include_purification |
Compute purification when TRUE. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_portfolio(client, list(list(ticker = "AAPL", shares = 100))) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_portfolio(client, list(list(ticker = "AAPL", shares = 100))) ## End(Not run)
OHLCV price history
axprism_prices(client, ticker, start = NULL, end = NULL, limit = 252)axprism_prices(client, ticker, start = NULL, end = NULL, limit = 252)
client |
An |
ticker |
Ticker symbol. |
start |
Optional start date (ISO). |
end |
Optional end date (ISO). |
limit |
Max bars (default 252). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_prices(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_prices(client, "AAPL") ## End(Not run)
Subscription pricing and entitlements
axprism_pricing(client)axprism_pricing(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_pricing(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_pricing(client) ## End(Not run)
Company profile, CIK, SIC, exchange, and Shariah activity screen
axprism_profile(client, ticker)axprism_profile(client, ticker)
client |
An |
ticker |
Ticker symbol, e.g. "AAPL". |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_profile(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_profile(client, "AAPL") ## End(Not run)
Purification amount for a single holding (USD)
axprism_purification(client, ticker, shares_held, dividend_per_share = NULL)axprism_purification(client, ticker, shares_held, dividend_per_share = NULL)
client |
An |
ticker |
Ticker symbol. |
shares_held |
Number of shares held. |
dividend_per_share |
Optional dividend per share (USD). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_purification(client, "AAPL", shares_held = 100) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_purification(client, "AAPL", shares_held = 100) ## End(Not run)
Generic escape hatch for any of the API's 165+ endpoints. Returns parsed JSON (a list). Honors retries/backoff and raises informative errors.
axprism_request(client, method, path, query = list(), body = NULL)axprism_request(client, method, path, query = list(), body = NULL)
client |
An |
method |
HTTP method: "GET", "POST", or "DELETE". |
path |
Endpoint path beginning with |
query |
Named list of query parameters (NULLs dropped). |
body |
Named list sent as a JSON request body (for POST). |
Parsed response (named list).
client <- axprism_client(api_key = "demo-key") ## Not run: # Requires network access and a valid API key. axprism_request(client, "GET", "/api/v1/health") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: # Requires network access and a valid API key. axprism_request(client, "GET", "/api/v1/health") ## End(Not run)
List supported Shariah compliance rulesets
axprism_rulesets(client)axprism_rulesets(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_rulesets(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_rulesets(client) ## End(Not run)
Screen tickers by compliance and fundamentals (max 50)
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 )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 )
client |
An |
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). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_screener(client, c("AAPL", "MSFT")) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_screener(client, c("AAPL", "MSFT")) ## End(Not run)
Reported business / geographic segments
axprism_segments(client, ticker, limit = 1)axprism_segments(client, ticker, limit = 1)
client |
An |
ticker |
Ticker symbol. |
limit |
Max filings (default 1). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_segments(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_segments(client, "AAPL") ## End(Not run)
Symbol search / suggestions
axprism_symbols(client, query = "", limit = 20)axprism_symbols(client, query = "", limit = 20)
client |
An |
query |
Search string. |
limit |
Max results (default 20). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_symbols(client, "apple") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_symbols(client, "apple") ## End(Not run)
Tadawul company financials
axprism_tadawul_financials(client, symbol, period = "annual")axprism_tadawul_financials(client, symbol, period = "annual")
client |
An |
symbol |
Tadawul symbol (e.g. "2222"). |
period |
"annual" or "quarterly". |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_tadawul_financials(client, "2222") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_tadawul_financials(client, "2222") ## End(Not run)
Tadawul (Saudi) symbols
axprism_tadawul_symbols(client, sector = NULL, limit = 200)axprism_tadawul_symbols(client, sector = NULL, limit = 200)
client |
An |
sector |
Optional sector filter. |
limit |
Max symbols (default 200). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_tadawul_symbols(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_tadawul_symbols(client) ## End(Not run)
Search indexed filing text blocks
axprism_text_search(client, q, ticker = NULL, form = NULL, limit = 20)axprism_text_search(client, q, ticker = NULL, form = NULL, limit = 20)
client |
An |
q |
Query string. |
ticker |
Optional ticker filter. |
form |
Optional form-type filter. |
limit |
Max hits (default 20). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_text_search(client, "climate risk") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_text_search(client, "climate risk") ## End(Not run)
Trailing twelve months income statement
axprism_ttm(client, ticker, currency = "NATIVE")axprism_ttm(client, ticker, currency = "NATIVE")
client |
An |
ticker |
Ticker symbol. |
currency |
Reporting currency (default "NATIVE"). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_ttm(client, "AAPL") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_ttm(client, "AAPL") ## End(Not run)
Request usage analytics
axprism_usage(client, days = 30)axprism_usage(client, days = 30)
client |
An |
days |
Look-back window in days (default 30). |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_usage(client, days = 30) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_usage(client, days = 30) ## End(Not run)
Create a webhook subscription
axprism_webhooks_create(client, url, event, ticker_filter = NULL)axprism_webhooks_create(client, url, event, ticker_filter = NULL)
client |
An |
url |
Callback URL. |
event |
Event type (see |
ticker_filter |
Optional ticker filter. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_create(client, "https://example.com/hook", "filing.created") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_create(client, "https://example.com/hook", "filing.created") ## End(Not run)
Delete a webhook subscription
axprism_webhooks_delete(client, sub_id)axprism_webhooks_delete(client, sub_id)
client |
An |
sub_id |
Subscription id. |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_delete(client, "sub_123") ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_delete(client, "sub_123") ## End(Not run)
List available webhook event types
axprism_webhooks_events(client)axprism_webhooks_events(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_events(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_events(client) ## End(Not run)
List webhook subscriptions
axprism_webhooks_list(client)axprism_webhooks_list(client)
client |
An |
Parsed API response as a named list.
client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_list(client) ## End(Not run)client <- axprism_client(api_key = "demo-key") ## Not run: axprism_webhooks_list(client) ## End(Not run)