@axionquant/sdk
v1.1.9
Published
Official TypeScript/JavaScript SDK for the AxionQuant financial data API. Real-time and historical stock, crypto, forex, futures, and economic data, plus SEC filings, earnings, and company financials.
Maintainers
axionquantReadme
AxionQuant SDK
The official TypeScript/JavaScript SDK for AxionQuant - a single financial data API for stocks, crypto, forex, futures, indices, ETFs, economic data, SEC filings, earnings, insider trading, and company financials.
AxionQuant (Axion) gives developers real-time and historical market data, fundamental financial statements, earnings call transcripts, SEC filings, insider trading activity, economic indicators, and more - all through one typed, promise-based Node.js client.
Why AxionQuant?
- All asset classes in one SDK - stocks, crypto, forex, futures, indices, and ETFs
- Fundamental & alternative data - financial statements, earnings, SEC filings, insider trading, ESG, credit ratings, web traffic, and supply chain data
- Macro & economic data - natural-language FRED dataset search and economic calendars
- Built for TypeScript - fully typed requests and responses
- Simple, consistent API - one client, one auth pattern, promise-based methods across every module
Table of Contents
Installation
npm install @axionquant/sdkQuick Start
Get your free AxionQuant API key
const { Axion } = require('@axionquant/sdk');
const client = new Axion('your-api-key');
// Get stock tickers
const tickers = await client.stocks.tickers({ country: 'US', exchange: 'NASDAQ' });
// Get historical prices
const prices = await client.stocks.prices('AAPL', {
from: '2024-01-01',
to: '2024-12-31',
frame: '1d'
});Authentication
Most endpoints require an AxionQuant API key. Pass it when initializing the client:
const client = new Axion('your-api-key');API Reference
Stocks
Real-time stock quotes, historical price data, ticker lookups, and top gainers/losers.
// Get all stock tickers
await client.stocks.tickers({ country: 'US', exchange: 'NASDAQ' });
// Get ticker info
await client.stocks.ticker('AAPL');
// Get historical prices
await client.stocks.prices('AAPL', { from: '2024-01-01', to: '2024-12-31', frame: '1d' });
// Get gainers and losers
await client.stocks.gainers({ days: 5, limit: 10, market: 'america' });
await client.stocks.losers({ days: 5, limit: 10 });
// Get stock quote
await client.stocks.quote('AAPL');Crypto
Cryptocurrency price data, quotes, and market movers.
await client.crypto.tickers({ type: 'coin' });
await client.crypto.ticker('BTC');
await client.crypto.prices('BTC', { from: '2024-01-01', to: '2024-12-31', frame: '1h' });
await client.crypto.gainers({ days: 5, limit: 10 });
await client.crypto.losers({ limit: 5 });
await client.crypto.quote('BTC');Forex
Foreign exchange rates and currency pair data.
await client.forex.tickers({ country: 'US' });
await client.forex.ticker('EURUSD');
await client.forex.prices('EURUSD', { from: '2024-01-01', to: '2024-12-31' });
await client.forex.gainers({ limit: 5 });
await client.forex.losers();
await client.forex.quote('EURUSD');Futures
Futures contract pricing and market data.
await client.futures.tickers({ exchange: 'CME' });
await client.futures.ticker('ES');
await client.futures.prices('ES', { from: '2024-01-01', to: '2024-12-31' });
await client.futures.gainers({ limit: 5 });
await client.futures.losers();
await client.futures.quote('ES');Indices
Market index data, constituents, and exposure.
await client.indices.tickers({ exchange: 'NYSE' });
await client.indices.ticker('SPX');
await client.indices.prices('SPX', { from: '2024-01-01', to: '2024-12-31' });
await client.indices.components('SPX');
await client.indices.exposure('AAPL');Financials
Financial statements, historical fundamentals, valuation ratios, and DCF analysis.
// Financial statements (balance sheet, income, cash flow)
await client.financials.balanceSheet('AAPL', { year: '2024', quarter: '1' });
await client.financials.incomeStatement('AAPL', { year: '2024', quarter: '1' });
await client.financials.cashFlowStatement('AAPL', { year: '2024', quarter: '1' });
// Historical financial metrics
await client.financials.revenue('AAPL', { periods: 8 });
await client.financials.netIncome('AAPL');
await client.financials.totalAssets('AAPL');
await client.financials.totalLiabilities('AAPL');
await client.financials.stockholdersEquity('AAPL');
await client.financials.currentAssets('AAPL');
await client.financials.currentLiabilities('AAPL');
await client.financials.operatingCashFlow('AAPL');
await client.financials.capitalExpenditures('AAPL');
await client.financials.freeCashFlow('AAPL');
await client.financials.sharesOutstandingBasic('AAPL');
await client.financials.sharesOutstandingDiluted('AAPL');
await client.financials.metrics('AAPL');
await client.financials.snapshot('AAPL');
// Historical valuation ratios
await client.financials.eps('AAPL', { from: '2024-01-01', to: '2024-12-31' });
await client.financials.pe('AAPL');
await client.financials.marketCap('AAPL');
await client.financials.roe('AAPL');
await client.financials.enterpriseValue('AAPL');
await client.financials.ebitda('AAPL');
await client.financials.debtToEquity('AAPL');
// DCF analysis
await client.financials.dcfValue('AAPL');
await client.financials.dcfRate('AAPL');Earnings
Earnings history, trends, reports, and call transcripts with sentiment analysis.
await client.earnings.history('AAPL');
await client.earnings.trend('AAPL');
await client.earnings.index('AAPL');
await client.earnings.report('AAPL', { year: '2024', quarter: 'Q1' });
await client.earnings.transcript('AAPL', { year: '2024', quarter: '2' });
await client.earnings.transcriptSentiment('base64-encoded-id');Filings
SEC filings search, history, and full-text document access.
// Get recent filings
await client.filings.recent('AAPL', { form: '10-K', limit: 10 });
// Get filing history by form type and date range
await client.filings.history('AAPL', '10-Q', { startDate: '2024-01-01', endDate: '2024-03-31' });
// List available form types
await client.filings.listForms();
// Search filings by year/quarter
await client.filings.search({ ticker: 'AAPL', form: '10-Q', year: '2024', quarter: 'Q1' });
// Get document text/sentiment
await client.filings.documentText('document-id');
await client.filings.documentSentiment('document-id');Insiders
Insider trading activity, institutional and fund ownership data.
await client.insiders.funds('AAPL');
await client.insiders.individuals('AAPL');
await client.insiders.institutions('AAPL');
await client.insiders.ownership('AAPL');
await client.insiders.activity('AAPL');
await client.insiders.transactions('AAPL');Company Profiles
Company overviews, analyst recommendations, and key statistics.
await client.profiles.profile('AAPL');
await client.profiles.recommendation('AAPL');
await client.profiles.statistics('AAPL');
await client.profiles.summary('AAPL');
await client.profiles.info('AAPL');
await client.profiles.calendar('AAPL');Sentiment
Social, news, and analyst sentiment scoring.
await client.sentiment.all('AAPL');
await client.sentiment.social('AAPL');
await client.sentiment.news('AAPL');
await client.sentiment.analyst('AAPL');News
Market news by company, country, and category.
await client.news.general();
await client.news.company('AAPL');
await client.news.country('US');
await client.news.category('technology');Economic Data
Macroeconomic indicators, FRED dataset search, and economic calendars.
// AI-powered FRED dataset finder (natural language)
await client.econ.find('semiconductor spending');
// Search datasets
await client.econ.search('unemployment rate');
// Get a dataset
await client.econ.dataset('UNRATE');
// Get economic calendar
await client.econ.calendar({
from: '2024-01-01',
to: '2024-12-31',
country: 'US',
minImportance: 3,
currency: 'USD',
category: 'employment',
limit: 25
});Credit
Credit ratings and entity search.
await client.credit.search('Apple Inc');
await client.credit.ratings('entity-id');ESG
Environmental, social, and governance (ESG) data.
await client.esg.data('AAPL');ETFs
ETF holdings, exposure, weights, and market movers.
await client.etfs.fund('SPY');
await client.etfs.holdings('SPY');
await client.etfs.holdingsAll('SPY');
await client.etfs.exposure('SPY');
await client.etfs.weights('SPY');
await client.etfs.gainers({ limit: 5 });
await client.etfs.losers();
await client.etfs.quote('SPY');Supply Chain
Company customer, supplier, and peer relationships.
await client.supplyChain.customers('AAPL');
await client.supplyChain.peers('AAPL');
await client.supplyChain.suppliers('AAPL');Web Traffic
Website traffic estimates by company.
await client.webTraffic.traffic('AAPL');Error Handling
try {
const data = await client.stocks.prices('AAPL');
console.log(data);
} catch (error) {
console.error('Error:', error.message);
}FAQ
What is AxionQuant? AxionQuant (Axion) is a financial data API and SDK that provides stock, crypto, forex, futures, and economic data alongside company fundamentals, SEC filings, and earnings data through a single client.
Does the AxionQuant SDK support TypeScript? Yes. The SDK is written for TypeScript/JavaScript and works in any Node.js project.
Is there a free AxionQuant API key? Yes - you can get a free API key from the AxionQuant dashboard.
What markets and data types does Axion cover? Stocks, crypto, forex, futures, indices, and ETFs, plus financial statements, earnings transcripts, SEC filings, insider trading, sentiment, news, economic (FRED) data, credit ratings, ESG scores, supply chain relationships, and web traffic estimates.
Get Started
For detailed API documentation, support, or to obtain an API key, visit AxionQuant.
License
MIT