@axprism/node

Official Node.js client for the AxPrism API.

For a richer, fully-typed TypeScript SDK (with retries, namespaces for Tadawul/Bursa/IDX, disclosures, webhooks, and more), use @axprism/sdk. This package is a lightweight CommonJS client.

Coming soon to npm. npm install @axprism/node will work once published. For now, install from a local checkout of this repo (no build step needed):

npm install /path/to/sdk/node

Authentication

AxPrism authenticates with the X-API-Key header. Get a key at axprism.com/keys. A public read-only demo key is available for testing: axmd_demo_try_axprism_2024.

const { AxPrismClient } = require("@axprism/node");

const client = new AxPrismClient({ apiKey: process.env.AXPRISM_API_KEY });
// or: new AxPrismClient({ apiKey: "axmd_live_..." })

const fin = await client.financials("AAPL", { period: "annual" });
const compliance = await client.compliance("AAPL", { standard: "aaoifi" });
const insiders = await client.insiders("NVDA");
const chain = await client.optionsChain("TSLA");

Requires Node.js 18+ (uses the global fetch).

See the full endpoint reference at https://axprism.com/api-reference.

License

MIT — see LICENSE.