axprism_client: Create an AxPrism API client

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

Create an AxPrism API client

Description

Create an AxPrism API client

Usage

axprism_client(
  api_key = NULL,
  base_url = "https://axprism.com",
  timeout_s = 30,
  max_retries = 3,
  backoff_s = 0.5
)

Arguments

api_key	Your AxPrism API key (axmd_live_...). Defaults to the AXPRISM_API_KEY environment variable.
base_url	API base URL. Defaults to https://axprism.com.
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).

Value

An object of class axprism_client.

Examples

# 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)

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