Axion JavaScript/TypeScript SDK
The Axion JavaScript SDK provides a comprehensive TypeScript-first wrapper for interacting with the Axion Financial API. This SDK offers full type safety, async/await support, and automatic error handling for financial data including ESG scores, stock prices, cryptocurrency data, forex, futures, indices, ETFs, economic indicators, company financials, insider transactions, SEC filings, earnings transcripts, news, sentiment analysis, supply chain, web traffic, and credit ratings.
Installation
Install the SDK via npm, yarn, or pnpm. The package includes both CommonJS and ES module builds, with full TypeScript definitions.
npm / yarn / pnpm
# npm
npm install @axionquant/sdk
# yarn
yarn add @axionquant/sdk
# pnpm
pnpm add @axionquant/sdkQuick Start
Initialize the client and start fetching data. All methods return Promises and are fully typed.
Steps
- Import the
Axionclass - Create a client with your API key
- Call methods on category properties (e.g.,
client.esg.data()) - Use
async/awaitto handle responses
Quick Start (TypeScript)
import { Axion } from '@axionquant/sdk';
const client = new Axion('your_api_key_here');
// Get ESG data for Apple
const esgData = await client.esg.data('AAPL');
console.log(esgData);
// Get stock prices for Microsoft
const prices = await client.stocks.prices('MSFT', {
from: '2024-01-01',
to: '2024-03-01'
});
console.log(prices);
// Get economic indicators
const gdp = await client.econ.dataset('GDP_USA');
// Get company news
const news = await client.news.company('AAPL');
// Get ETF holdings
const holdings = await client.etfs.holdings('SPY');Client Initialization
The Axion client can be initialized with or without an API key. When no key is provided at construction, it must be included in the Authorization header of each request.
Constructor Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | string | Optional | Your Axion API key. If omitted, you must provide it per request. |
TypeScript Example
import { Axion } from '@axionquant/sdk';
import type { ApiResponse } from '@axionquant/sdk';
const client = new Axion('your_api_key_here');
async function fetchFinancialData() {
try {
const esgData: ApiResponse = await client.esg.data('AAPL');
const stockPrices: ApiResponse = await client.stocks.prices('MSFT');
return { esgData, stockPrices };
} catch (error) {
console.error('Error:', error);
throw error;
}
}API Categories
The SDK is organized into 18 specialized API classes, each accessible as a property of the main client. All methods are promise-based and fully typed.
client.credit
Credit ratings & entity search
credit.search(query)credit.ratings(entityId)client.esg
Environmental, Social, Governance
esg.data(ticker)client.etfs
ETF fund data, holdings, exposure
etfs.tickers(params?)etfs.ticker(ticker)etfs.prices(ticker, params?)etfs.quote(ticker)etfs.fund(ticker)etfs.holdings(ticker)etfs.holdingsAll(ticker)etfs.weights(ticker)etfs.exposure(ticker)etfs.gainers(params?)etfs.losers(params?)etfs.list(column)client.supplyChain
Customers, peers, suppliers
supplyChain.customers(ticker)supplyChain.peers(ticker)supplyChain.suppliers(ticker)client.stocks
Stock quotes, prices, tickers
stocks.tickers(params?)stocks.ticker(ticker)stocks.prices(ticker, params?)stocks.quote(ticker)stocks.gainers(params?)stocks.losers(params?)stocks.list(column)client.crypto
Cryptocurrency data
crypto.tickers(params?)crypto.ticker(ticker)crypto.prices(ticker, params?)crypto.quote(ticker)crypto.gainers(params?)crypto.losers(params?)crypto.list(column)client.profiles
Company profiles, info, statistics
profiles.profile(ticker)profiles.info(ticker)profiles.summary(ticker)profiles.statistics(ticker)profiles.recommendation(ticker)profiles.calendar(ticker)client.sentiment
News & social sentiment
sentiment.all(ticker)sentiment.social(ticker)sentiment.news(ticker)sentiment.analyst(ticker)client.financials
Comprehensive financial metrics
financials.revenue(ticker, params?)financials.balanceSheet(ticker, params?)financials.incomeStatement(ticker, params?)financials.cashFlowStatement(ticker, params?)financials.metrics(ticker)financials.snapshot(ticker)financials.dcfValue(ticker)financials.dcfRate(ticker)financials.eps(ticker, params?)financials.pe(ticker, params?)financials.marketCap(ticker, params?)financials.roe(ticker, params?)financials.enterpriseValue(ticker, params?)financials.ebitda(ticker, params?)financials.debtToEquity(ticker, params?)client.earnings
Earnings history, trends, reports
earnings.history(ticker)earnings.trend(ticker)earnings.index(ticker)earnings.report(ticker, params)earnings.transcript(ticker, params)earnings.transcriptSentiment(id)client.filings
SEC filings and forms
filings.recent(ticker, params?)filings.history(ticker, formType, params?)filings.listForms()filings.search(params)filings.documentText(documentId)filings.documentSentiment(documentId)client.insiders
Insider transactions & ownership
insiders.funds(ticker)insiders.individuals(ticker)insiders.institutions(ticker)insiders.ownership(ticker)insiders.activity(ticker)insiders.transactions(ticker)client.forex
Foreign exchange currency data
forex.tickers(params?)forex.ticker(ticker)forex.prices(ticker, params?)forex.quote(ticker)forex.gainers(params?)forex.losers(params?)forex.list(column)client.futures
Commodity & financial futures
futures.tickers(params?)futures.ticker(ticker)futures.prices(ticker, params?)futures.quote(ticker)futures.gainers(params?)futures.losers(params?)futures.list(column)client.indices
Stock market indices
indices.tickers(params?)indices.ticker(ticker)indices.prices(ticker, params?)indices.quote(ticker)indices.components(ticker)indices.exposure(ticker)indices.gainers(params?)indices.losers(params?)indices.list(column)client.econ
Economic indicators & calendar
econ.find(query)econ.search(query)econ.dataset(seriesId)econ.calendar(params?)client.news
Financial news by company/country
news.general()news.company(ticker)news.country(country)news.category(category)client.webTraffic
Website traffic analytics
webTraffic.traffic(ticker)Profiles API
client.profilesComprehensive company profiles, statistics, recommendations, and calendar events.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| profile(ticker) | Get asset profile | ticker: string |
| recommendation(ticker) | Get recommendation trends | ticker: string |
| statistics(ticker) | Get key statistics | ticker: string |
| summary(ticker) | Get summary details | ticker: string |
| calendar(ticker) | Get earnings & dividend calendar | ticker: string |
| info(ticker) | Get company info (summary profile) | ticker: string |
Profiles API - Example
// Company profile
const profile = await client.profiles.profile('AAPL');
console.log(`Company: ${profile.name}`);
// Recommendation trends
const recommendations = await client.profiles.recommendation('AAPL');
console.log(`Strong Buy: ${recommendations.strongBuy}`);
// Key statistics
const stats = await client.profiles.statistics('AAPL');
console.log(`Market Cap: ${stats.marketCap}`);
// Calendar events
const calendar = await client.profiles.calendar('AAPL');
console.log(`Next Earnings: ${calendar.earnings[0].date}`);Financials API
client.financialsDetailed financial metrics, statements, and calculated ratios.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| balanceSheet(ticker, params?) | Balance sheet statement | ticker: string, params?: { year?: string, quarter?: string } |
| incomeStatement(ticker, params?) | Income statement | ticker: string, params?: { year?: string, quarter?: string } |
| cashFlowStatement(ticker, params?) | Cash flow statement | ticker: string, params?: { year?: string, quarter?: string } |
| revenue(ticker, params?) | Revenue data | ticker: string, params?: { periods?: number } |
| netIncome(ticker, params?) | Net income | ticker: string, params?: { periods?: number } |
| totalAssets(ticker, params?) | Total assets | ticker: string, params?: { periods?: number } |
| totalLiabilities(ticker, params?) | Total liabilities | ticker: string, params?: { periods?: number } |
| stockholdersEquity(ticker, params?) | Stockholders equity | ticker: string, params?: { periods?: number } |
| currentAssets(ticker, params?) | Current assets | ticker: string, params?: { periods?: number } |
| currentLiabilities(ticker, params?) | Current liabilities | ticker: string, params?: { periods?: number } |
| operatingCashFlow(ticker, params?) | Operating cash flow | ticker: string, params?: { periods?: number } |
| capitalExpenditures(ticker, params?) | CapEx | ticker: string, params?: { periods?: number } |
| freeCashFlow(ticker, params?) | Free cash flow | ticker: string, params?: { periods?: number } |
| sharesOutstandingBasic(ticker, params?) | Basic shares | ticker: string, params?: { periods?: number } |
| sharesOutstandingDiluted(ticker, params?) | Diluted shares | ticker: string, params?: { periods?: number } |
| metrics(ticker) | Calculated metrics | ticker: string |
| snapshot(ticker) | Financial snapshot | ticker: string |
| dcfValue(ticker) | DCF valuation | ticker: string |
| dcfRate(ticker) | Discount rate / WACC | ticker: string |
Financials API - Example
// Revenue data for last 4 quarters
const revenue = await client.financials.revenue('AAPL', { periods: 4 });
console.log('Quarterly Revenue:', revenue);
// Key financial metrics
const metrics = await client.financials.metrics('AAPL');
console.log(`P/E Ratio: ${metrics.pe_ratio}`);
console.log(`ROE: ${metrics.return_on_equity}`);
// Complete financial snapshot
const snapshot = await client.financials.snapshot('AAPL');
console.log(snapshot);
// DCF analysis
const dcfValue = await client.financials.dcfValue('AAPL');
console.log(`Fair Price: ${dcfValue.fairPrice}, Recommendation: ${dcfValue.recommendation}`);
const dcfRate = await client.financials.dcfRate('AAPL');
console.log(`WACC: ${(dcfRate.wacc * 100).toFixed(2)}%`);
// Financial statements
const balanceSheet = await client.financials.balanceSheet('AAPL');
const income = await client.financials.incomeStatement('AAPL');
const cashflow = await client.financials.cashFlowStatement('AAPL');Earnings API
client.earningsHistorical earnings data, trends, and detailed reports.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| history(ticker) | Earnings history | ticker: string |
| trend(ticker) | Earnings trend | ticker: string |
| index(ticker) | Index trend | ticker: string |
| report(ticker, params) | Detailed earnings report | ticker: string, params: { year: string, quarter: string } |
| transcript(ticker, params) | Earnings call transcript | ticker: string, params: { year: string, quarter: string } |
| transcriptSentiment(id) | Earnings transcript sentiment | id: string |
Earnings API - Example
// Earnings history
const history = await client.earnings.history('MSFT');
console.log(`EPS Q1: ${history[0].eps}`);
// Specific quarter report
const report = await client.earnings.report('MSFT', {
year: '2024',
quarter: 'Q1'
});
console.log(`Revenue: ${report.revenue}`);
console.log(`EPS: ${report.eps}`);
// Earnings call transcript
const transcript = await client.earnings.transcript('MSFT', {
year: '2024',
quarter: 'Q1'
});
console.log(`Transcript: ${transcript.text.substring(0, 200)}...`);
// Transcript sentiment
const sentiment = await client.earnings.transcriptSentiment('transcript_id');
console.log(`Sentiment: ${sentiment.score}`);Filings API
client.filingsSEC filings search and retrieval.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| recent(ticker, params?) | Get recent filings | ticker: string, params?: { limit?: number, form?: string } |
| history(ticker, formType, params?) | Get specific form type by date range | ticker: string, formType: string, params?: { startDate?: string, endDate?: string } |
| listForms() | List available form types | none |
| search(params) | Search filings by year/quarter | params: { ticker?: string, form?: string, year: string, quarter: string } |
| documentText(documentId) | Get raw text of a filing document | documentId: string |
| documentSentiment(documentId) | Get sentiment analysis of a filing | documentId: string |
Filings API - Example
// Get recent 10-K filings
const filings = await client.filings.recent('AAPL', {
form: '10-K',
limit: 3
});
// Search for Q1 2024 filings
const searchResults = await client.filings.search({
ticker: 'AAPL',
year: '2024',
quarter: 'Q1'
});
// Get all 10-Q filings for Q1 2024
const forms = await client.filings.history('AAPL', '10-Q', {
startDate: '2024-01-01',
endDate: '2024-03-31'
});
// Get raw document text and sentiment
const text = await client.filings.documentText('document_id_here');
const sentiment = await client.filings.documentSentiment('document_id_here');
console.log(`Sentiment: ${sentiment.score}`);Insiders API
client.insidersInsider ownership, transactions, and institutional holdings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| funds(ticker) | Fund ownership data | ticker: string |
| individuals(ticker) | Insider holders (individuals) | ticker: string |
| institutions(ticker) | Institutional ownership | ticker: string |
| ownership(ticker) | Major holders breakdown | ticker: string |
| activity(ticker) | Net share purchase activity | ticker: string |
| transactions(ticker) | Insider transactions | ticker: string |
Insiders API - Example
// Institutional ownership
const institutions = await client.insiders.institutions('AAPL');
console.log(`Top Holder: ${institutions[0].name} (${institutions[0].shares} shares)`);
// Recent insider transactions
const transactions = await client.insiders.transactions('AAPL');
transactions.slice(0,5).forEach(t => {
console.log(`${t.insider}: ${t.shares} shares ${t.type}`);
});
// Ownership breakdown
const ownership = await client.insiders.ownership('AAPL');
console.log(`Insider Ownership: ${ownership.insider_percent}%`);Web Traffic API
client.webTrafficWebsite traffic data and analytics for companies.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| traffic(ticker) | Get web traffic data | ticker: string |
WebTraffic API - Example
// Get web traffic for Amazon
const traffic = await client.webTraffic.traffic('AMZN');
console.log(`Monthly Visits: ${traffic.monthly_visits}`);
console.log(`YoY Growth: ${traffic.yoy_growth}%`);ETF API
client.etfsETF tickers, quotes, prices, fund details, holdings, weights, exposure, gainers/losers, and metadata listings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Filtered list of ETF tickers | params?: { country?: string, exchange?: string } |
| ticker(ticker) | Current quote for a single ETF | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| fund(ticker) | Fund overview and details | ticker: string |
| holdings(ticker) | Top holdings breakdown | ticker: string |
| holdingsAll(ticker) | All holdings with weights | ticker: string |
| weights(ticker) | Fund allocation weights | ticker: string |
| exposure(ticker) | Exposure analysis | ticker: string |
| gainers(params?) | Top gaining ETFs | params?: { days?: number, limit?: number } |
| losers(params?) | Top losing ETFs | params?: { days?: number, limit?: number } |
| list(column) | List metadata by column | column: string |
ETF API - Example
// All US ETFs
const usEtfs = await client.etfs.tickers({ country: 'US' });
// SPY quote
const spyQuote = await client.etfs.ticker('SPY');
console.log(`SPY: $${spyQuote.price}`);
// Fund details and holdings
const spyFund = await client.etfs.fund('SPY');
const spyHoldings = await client.etfs.holdings('SPY');
const spyAllHoldings = await client.etfs.holdingsAll('SPY');
// Historical prices
const spyPrices = await client.etfs.prices('SPY', {
from: '2024-01-01',
to: '2024-03-31'
});Stocks API
client.stocksAccess stock tickers, real-time quotes, historical price data, gainers/losers, and market metadata.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Filtered list of stock tickers | params?: { country?: string, exchange?: string } |
| ticker(ticker) | Current quote for a single symbol | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| gainers(params?) | Top gaining stocks | params?: { days?: number, limit?: number, market?: string } |
| losers(params?) | Top losing stocks | params?: { days?: number, limit?: number, market?: string } |
| list(column) | List metadata by column | column: string |
Stocks API - Example
// All US tickers
const usStocks = await client.stocks.tickers({ country: 'US' });
// Apple quote
const appleQuote = await client.stocks.ticker('AAPL');
console.log(`Price: ${appleQuote.price}`);
// Historical weekly prices for Microsoft
const msftPrices = await client.stocks.prices('MSFT', {
from: '2024-01-01',
to: '2024-03-31',
frame: 'weekly'
});
// Top gainers this week
const gainers = await client.stocks.gainers({ days: 7, limit: 10 });
// List available sectors
const sectors = await client.stocks.list('sector');Cryptocurrency API
client.cryptoCryptocurrency tickers, real-time quotes, historical price data, gainers/losers, and metadata listings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Get all crypto tickers | params?: { type?: string } |
| ticker(ticker) | Get quote by symbol | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| gainers(params?) | Top gaining cryptocurrencies | params?: { days?: number, limit?: number } |
| losers(params?) | Top losing cryptocurrencies | params?: { days?: number, limit?: number } |
| list(column) | List metadata by column | column: string |
Crypto API - Example
// All cryptocurrencies
const allCrypto = await client.crypto.tickers();
// Bitcoin quote
const btc = await client.crypto.ticker('BTC-USD');
console.log(`Bitcoin: $${btc.price}`);
// Ethereum historical daily prices
const ethPrices = await client.crypto.prices('ETH-USD', {
from: '2024-01-01',
to: '2024-03-31',
frame: 'daily'
});
// Top crypto gainers
const topGainers = await client.crypto.gainers({ days: 1, limit: 5 });Economic API
client.econEconomic indicators, AI-powered FRED search, datasets, and calendar events.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| find(query) | AI-powered FRED series search | query: string |
| search(query) | Search for economic series | query: string |
| dataset(seriesId) | Get series observations | seriesId: string |
| calendar(params?) | Economic calendar with filters | params?: { from?: string, to?: string, country?: string, minImportance?: number, currency?: string, category?: string, limit?: number } |
Economic API - Example
// AI-powered FRED series search
const series = await client.econ.find('US GDP quarterly');
// Search for inflation series
const inflationSeries = await client.econ.search('inflation');
// Get GDP dataset
const gdpData = await client.econ.dataset('GDP_USA');
// Important US economic events this month
const calendar = await client.econ.calendar({
from: '2024-04-01',
to: '2024-04-30',
country: 'US',
minImportance: 3
});Forex API
client.forexForeign exchange currency tickers, quotes, historical prices, gainers/losers, and metadata listings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Filtered list of forex pairs | params?: { country?: string, exchange?: string } |
| ticker(ticker) | Current quote for a currency pair | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| gainers(params?) | Top gaining currency pairs | params?: { days?: number, limit?: number } |
| losers(params?) | Top losing currency pairs | params?: { days?: number, limit?: number } |
| list(column) | List metadata by column | column: string |
Forex API - Example
// All EUR forex pairs
const eurPairs = await client.forex.tickers({ country: 'EUR' });
// EUR/USD quote
const eurusd = await client.forex.ticker('EUR-USD');
console.log(`EUR/USD: ${eurusd.price}`);
// Historical prices
const eurGbpPrices = await client.forex.prices('EUR-GBP', {
from: '2024-01-01',
to: '2024-03-31',
frame: 'daily'
});Futures API
client.futuresCommodity and financial futures tickers, quotes, historical prices, gainers/losers, and metadata listings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Filtered list of futures tickers | params?: { exchange?: string } |
| ticker(ticker) | Current quote for a futures contract | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| gainers(params?) | Top gaining futures contracts | params?: { days?: number, limit?: number } |
| losers(params?) | Top losing futures contracts | params?: { days?: number, limit?: number } |
| list(column) | List metadata by column | column: string |
Futures API - Example
// Crude oil futures quote
const crudeOil = await client.futures.ticker('CL');
console.log(`Crude Oil: $${crudeOil.price}`);
// Historical gold futures prices
const goldPrices = await client.futures.prices('GC', {
from: '2024-01-01',
to: '2024-03-31',
frame: 'daily'
});Indices API
client.indicesStock market indices tickers, quotes, historical prices, components, exposure analysis, gainers/losers, and metadata listings.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(params?) | Filtered list of indices | params?: { exchange?: string } |
| ticker(ticker) | Current quote for an index | ticker: string |
| prices(ticker, params?) | Historical prices | ticker: string, params?: { from?: string, to?: string, frame?: string } |
| quote(ticker) | Real-time quote data | ticker: string |
| components(ticker) | Get index constituent holdings | ticker: string |
| exposure(ticker) | Which indices hold a given ticker | ticker: string |
| gainers(params?) | Top gaining indices | params?: { days?: number, limit?: number } |
| losers(params?) | Top losing indices | params?: { days?: number, limit?: number } |
| list(column) | List metadata by column | column: string |
Indices API - Example
// S&P 500 quote
const spx = await client.indices.ticker('SPX');
console.log(`S&P 500: ${spx.price}`);
// Dow Jones components
const dowComponents = await client.indices.components('DJI');
console.log(`Components: ${dowComponents.length}`);
// Which indices hold AAPL
const aaplExposure = await client.indices.exposure('AAPL');
console.log(`Found in ${aaplExposure.indices.length} indices`);News API
client.newsFinancial news retrieval by company, country, and category, plus general market news.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| general() | General market news feed | none |
| company(ticker) | News for a specific company | ticker: string |
| country(country) | News by country | country: string |
| category(category) | News by category | category: string |
News API - Example
// General market news
const marketNews = await client.news.general();
console.log(`Latest: ${marketNews.articles[0].headline}`);
// News for Apple
const aaplNews = await client.news.company('AAPL');
// News by country
const ukNews = await client.news.country('GB');Complete Example
A comprehensive TypeScript application demonstrating multiple API calls, error handling, and portfolio monitoring.
import { Axion } from '@axionquant/sdk';
class FinancialAnalyst {
private client: Axion;
constructor(apiKey: string) {
this.client = new Axion(apiKey);
}
async analyzeCompany(ticker: string) {
try {
const [profile, esg, quote, sentiment, financials] = await Promise.all([
this.client.profiles.profile(ticker),
this.client.esg.data(ticker),
this.client.stocks.ticker(ticker),
this.client.sentiment.all(ticker),
this.client.financials.snapshot(ticker)
]);
console.log(`${profile.name}: $${quote.price} | ESG: ${esg.score} | Sentiment: ${sentiment.overall_score}`);
console.log(`P/E: ${financials.pe_ratio} | Revenue: ${financials.revenue}`);
return { profile, esg, quote, sentiment, financials };
} catch (error) {
console.error(`Failed to analyze ${ticker}:`, error);
return null;
}
}
async monitorPortfolio(tickers: string[]) {
setInterval(async () => {
const updates = await Promise.all(
tickers.map(t => this.client.stocks.quote(t))
);
console.log(new Date().toLocaleTimeString());
updates.forEach(u =>
console.log(`${u.symbol}: $${u.price} (${u.change_percent}%)`)
);
}, 60000); // every minute
}
async getEconomicInsights() {
const gdp = await this.client.econ.dataset('GDP_USA');
const calendar = await this.client.econ.calendar({
country: 'US',
minImportance: 3
});
return { gdp, calendar };
}
async getETFData(ticker: string) {
const [fund, holdings, weights] = await Promise.all([
this.client.etfs.fund(ticker),
this.client.etfs.holdings(ticker),
this.client.etfs.weights(ticker)
]);
return { fund, holdings, weights };
}
}
// Usage
const analyst = new FinancialAnalyst(process.env.AXION_API_KEY!);
analyst.analyzeCompany('AAPL');
analyst.monitorPortfolio(['AAPL', 'MSFT', 'GOOGL']);
analyst.getEconomicInsights();
analyst.getETFData('SPY');Error Handling
The SDK throws descriptive errors that can be caught and handled gracefully.
Error Types
| Error Pattern | Description |
|---|---|
| HTTP Error {status}: {message} | Client or server error with status code |
| Connection Error | Network failure reaching the API |
| Authentication required | No API key provided to client |
| Request Error | Invalid parameters or request setup |
Error handling with retry
try {
const data = await client.esg.data('INVALID');
} catch (error) {
if (error.message.includes('404')) {
console.log('Ticker not found');
} else if (error.message.includes('429')) {
// Rate limit - exponential backoff
await delay(1000);
return fetchWithRetry();
} else if (error.message.includes('Authentication')) {
console.error('API key missing - provide one to the client');
} else if (error.message.includes('Connection')) {
console.error('Network error - check your connection');
}
throw error;
}TypeScript Support
The SDK is written in TypeScript and provides complete type definitions.
Complete Type Safety
All methods have full parameter and return types.
Auto-completion
IDE support for all methods and parameters.
Custom Type Extensions
Easily extend or override types for your domain.
TypeScript example
import { Axion } from '@axionquant/sdk';
import type { ApiResponse } from '@axionquant/sdk';
import SEOMetadata from '@/components/SEOMetadata';
interface CustomESG {
score: number;
grade: string;
environmental: number;
}
class Analyst {
client = new Axion(process.env.API_KEY!);
async getESG(ticker: string): Promise<CustomESG> {
const data = await this.client.esg.data(ticker);
return {
score: data.score,
grade: data.grade,
environmental: data.environmental_score
};
}
}Axion Python SDK
The Axion Python SDK provides a comprehensive wrapper for interacting with the Axion Financial API. This SDK simplifies access to financial data including ESG scores, stock prices, cryptocurrency data, economic indicators, company financials, insider trading, SEC filings, and more. All methods return normalized Python data structures with proper type coercion.
Installation
Install the SDK via pip, or clone the repository for development.
pip / GitHub
# Install via pip
pip install axionquant-sdk
# Or clone from GitHub
git clone https://github.com/axionquant/python-sdk.git
cd python-sdk
pip install -e .Quick Start
Initialize the client and start fetching data. All methods return normalized Python objects.
Steps
- Import the
Axionclass fromaxion - Create a client with your API key
- Call methods on category attributes (e.g.,
client.stocks.quote("AAPL")) - Use the returned dict/list directly (numbers, booleans are already converted)
Quick Start (Python)
from axion import Axion
# Initialize client
client = Axion(api_key="your_api_key_here")
# Get stock data
quote = client.stocks.quote("AAPL")
print(f"Apple price: {quote['price']}")
# Get ESG data
esg = client.esg.data("AAPL")
print(f"ESG Score: {esg['score']}")
# Get company profile
profile = client.profiles.info("AAPL")
print(f"Company: {profile['name']}")Client Initialization
The Axion client requires an API key for authentication. The SDK is organized into 18 specialized API classes, accessible as attributes of the main client.
Constructor Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api_key | str | Optional* | Your Axion API key. If omitted, it must be provided in the Authorization header per request, but most endpoints require authentication. |
Initialization example
from axion import Axion
# Recommended: set API key once
client = Axion(api_key="your_api_key_here")
# All API categories are now available
credit = client.credit.search("Apple")
esg = client.esg.data("AAPL")
stocks = client.stocks.quote("AAPL")
crypto = client.crypto.quote("BTC-USD")API Categories
The SDK is organized into 18 specialized API classes, each handling a specific data domain. All API classes are accessible as attributes of the main client.
client.credit
Credit ratings & entity search
credit.search()credit.ratings()client.esg
Environmental, Social, Governance
esg.data()client.etfs
ETF fund data, holdings, exposure
etfs.tickers()etfs.ticker()etfs.prices()etfs.fund()etfs.holdings()etfs.holdings_all()etfs.exposure()etfs.weights()etfs.gainers()etfs.losers()etfs.quote()client.supply_chain
Customers, peers, suppliers
supply_chain.customers()supply_chain.peers()supply_chain.suppliers()client.stocks
Stock quotes, prices, tickers
stocks.tickers()stocks.ticker()stocks.quote()stocks.prices()stocks.gainers()stocks.losers()client.crypto
Cryptocurrency data
crypto.tickers()crypto.ticker()crypto.quote()crypto.prices()crypto.gainers()crypto.losers()client.forex
Foreign exchange currency data
forex.tickers()forex.ticker()forex.quote()forex.prices()forex.gainers()forex.losers()client.futures
Commodity & financial futures
futures.tickers()futures.ticker()futures.quote()futures.prices()futures.gainers()futures.losers()client.indices
Stock market indices
indices.tickers()indices.ticker()indices.quote()indices.prices()indices.gainers()indices.losers()indices.components()indices.exposure()client.econ
Economic indicators & calendar
econ.find()econ.search()econ.dataset()econ.calendar()client.news
Financial news articles
news.general()news.company()news.country()news.category()client.sentiment
News & social sentiment
sentiment.all()sentiment.social()sentiment.news()sentiment.analyst()client.profiles
Company profiles & summaries
profiles.profile()profiles.info()profiles.statistics()profiles.summary()profiles.calendar()profiles.recommendation()client.earnings
Earnings data & estimates
earnings.history()earnings.trend()earnings.index()earnings.report()earnings.transcript()earnings.transcript_sentiment()client.filings
SEC filings data
filings.recent()filings.history()filings.list_forms()filings.search()filings.document_sentiment()filings.document_text()client.financials
Financial statements & metrics
financials.revenue()financials.metrics()financials.snapshot()financials.balance_sheet()financials.income_statement()financials.cash_flow_statement()financials.dcf_value()financials.dcf_rate()financials.eps()financials.pe()financials.market_cap()financials.roe()financials.enterprise_value()financials.ebitda()financials.debt_to_equity()+24 more financial metricsclient.insiders
Insider trading data
insiders.funds()insiders.individuals()insiders.institutions()insiders.ownership()insiders.activity()insiders.transactions()client.web_traffic
Website traffic analytics
web_traffic.traffic()Stocks API
client.stocksMethods for accessing stock market data including tickers, quotes, and historical prices.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(country, exchange) | Get all stock tickers with optional filtering | country: str = None, exchange: str = None |
| ticker(ticker) | Get a single stock ticker by its symbol | ticker: str |
| quote(ticker) | Get current quote for a stock | ticker: str |
| prices(ticker, from_date, to_date, frame) | Get historical stock prices | ticker: str, from_date: str = None, to_date: str = None, frame: str = 'daily' |
| gainers(days, limit, market) | Get top stock gainers | days: int = None, limit: int = None, market: str = None |
| losers(days, limit, market) | Get top stock losers | days: int = None, limit: int = None, market: str = None |
Stocks API - Example
# Get all US stock tickers
us_stocks = client.stocks.tickers(country="US")
# Get quote for a single stock
aapl = client.stocks.quote("AAPL")
print(f"Apple: {aapl['price']} ({aapl['change']}%)")
# Get historical prices with date range
prices = client.stocks.prices(
"MSFT",
from_date="2024-01-01",
to_date="2024-03-31",
frame="weekly"
)
# Convert to pandas DataFrame
import pandas as pd
df = pd.DataFrame(prices)
df['date'] = pd.to_datetime(df['date'])
print(df.head())Cryptocurrency API
client.cryptoMethods for accessing cryptocurrency data including tickers, quotes, and historical prices.
Available Methods
| Method | Description | Parameters |
|---|---|---|
| tickers(type) | Get all cryptocurrency tickers with optional filtering by type | type: str = None |
| ticker(ticker) | Get a single cryptocurrency ticker by its symbol | ticker: str |
| quote(ticker) | Get current quote for a cryptocurrency | ticker: str |
| prices(ticker, from_date, to_date, frame) | Get historical prices for a cryptocurrency | ticker: str, from_date: str = None, to_date: str = None, frame: str = 'daily' |
| gainers(days, limit) | Get top crypto gainers | days: int = None, limit: int = None |
| losers(days, limit) | Get top crypto losers | days: int = None, limit: int = None |
Crypto API - Example
# Get all crypto tickers
all_crypto = client.crypto.tickers()
# Filter by type (e.g., "coin", "token")
stablecoins = client.crypto.tickers(type="stablecoin")
# Get Bitcoin quote
btc = client.crypto.quote("BTC-USD")
print(f"Bitcoin: {btc['price']:,.2f}")
# Get Ethereum historical prices
eth_prices = client.crypto.prices(
"ETH-USD",
from_date="2024-01-01",
to_date="2024-03-31",
frame="daily"
)Profiles API
client.profilesComprehensive company profiles, business summaries, and market data.
Available Methods
| Method | Description |
|---|---|
| profile(ticker) | Get asset profile and business summary |
| info(ticker) | Get company profile information |
| statistics(ticker) | Get key statistics and financial ratios |
| summary(ticker) | Get summary detail including prices and volumes |
| calendar(ticker) | Get calendar events including earnings and dividends |
| recommendation(ticker) | Get analyst recommendation trends |
Profiles API - Example
# Get company profile
profile = client.profiles.profile("AAPL")
print(f"Company: {profile['name']}")
print(f"Industry: {profile['industry']}")
print(f"Sector: {profile['sector']}")
# Get key statistics
stats = client.profiles.statistics("AAPL")
print(f"Market Cap: {stats['market_cap']:,.0f}")
print(f"P/E Ratio: {stats['pe_ratio']}")
# Get upcoming events
calendar = client.profiles.calendar("AAPL")
for event in calendar:
print(f"{event['date']}: {event['event_type']}")Financials API
client.financialsComprehensive financial statement data and calculated metrics.
Key Methods
financials.revenue(ticker, periods)financials.net_income(ticker, periods)financials.total_assets(ticker, periods)financials.total_liabilities(ticker, periods)financials.stockholders_equity(ticker, periods)financials.current_assets(ticker, periods)financials.current_liabilities(ticker, periods)financials.operating_cash_flow(ticker, periods)financials.capital_expenditures(ticker, periods)financials.free_cash_flow(ticker, periods)financials.shares_outstanding_basic(ticker, periods)financials.shares_outstanding_diluted(ticker, periods)financials.balance_sheet(ticker, year, quarter)financials.income_statement(ticker, year, quarter)financials.cash_flow_statement(ticker, year, quarter)financials.metrics(ticker)financials.snapshot(ticker)financials.dcf_value(ticker)financials.dcf_rate(ticker)financials.eps(ticker, from, to)financials.pe(ticker, from, to, frame)financials.market_cap(ticker, from, to, frame)financials.roe(ticker, from, to)financials.enterprise_value(ticker, from, to, frame)financials.ebitda(ticker, from, to)financials.debt_to_equity(ticker, from, to)Metric methods accept optional periods parameter. Statement methods accept optional year and quarter. Historical valuation methods accept optional from, to, and frame parameters.
Financials API - Example
# Get revenue history (last 4 quarters)
revenue = client.financials.revenue("AAPL", periods=4)
for period in revenue:
print(f"{period['date']}: {period['value']:,.0f}")
# Get comprehensive financial snapshot
snapshot = client.financials.snapshot("AAPL")
print(f"Revenue (TTM): {snapshot['revenue_ttm']:,.0f}")
print(f"Gross Margin: {snapshot['gross_margin']}%")
print(f"Operating Margin: {snapshot['operating_margin']}%")
print(f"Debt/Equity: {snapshot['debt_to_equity']}")
# Calculate free cash flow trend
fcf = client.financials.free_cash_flow("AAPL", periods=5)
fcf_values = [period['value'] for period in fcf]
print(f"FCF Trend: {fcf_values}")
# DCF valuation
dcf = client.financials.dcf_value("AAPL")
print(f"Fair Price: {dcf['fair_price']:.2f}, Recommendation: {dcf['recommendation']}")
# Discount rate / WACC
rate = client.financials.dcf_rate("AAPL")
print(f"WACC: {rate['wacc'] * 100:.2f}%")Filings API (SEC)
client.filingsAccess SEC filings data for public companies.
Available Methods
| Method | Description |
|---|---|
| recent(ticker, limit, form) | Get recent SEC filings for a company |
| history(ticker, form_type, start_date, end_date) | Get specific form type filings by date range |
| list_forms() | List available SEC form types and descriptions |
| search(ticker, form, year, quarter) | Search filings by year/quarter and optional filters |
| document_sentiment(document_id) | Get sentiment analysis of an SEC filing document by its base64 document ID |
| document_text(document_id) | Get raw text content of an SEC filing document by its base64 document ID |
Filings API - Example
# List all available form types
form_types = client.filings.list_forms()
print(form_types[:5])
# Get recent 10-K filings for Apple
filings = client.filings.recent("AAPL", form="10-K", limit=5)
for filing in filings:
print(f"{filing['filed_date']}: {filing['form']}")
# Search for Q1 2024 filings
q1_filings = client.filings.search(
form="10-Q",
year="2024",
quarter="Q1"
)
# Get specific 10-Q filing in Q1 2024
ten_q = client.filings.history(
"AAPL",
form_type="10-Q",
start_date="2024-01-01",
end_date="2024-03-31"
)Insiders API
client.insidersAccess insider trading data, institutional ownership, and fund holdings.
Available Methods
| Method | Description |
|---|---|
| funds(ticker) | Get fund ownership data |
| individuals(ticker) | Get insider holders (individuals) |
| institutions(ticker) | Get institutional ownership data |
| ownership(ticker) | Get major holders breakdown |
| activity(ticker) | Get net share purchase activity |
| transactions(ticker) | Get insider transactions |
Insiders API - Example
# Get institutional ownership
institutions = client.insiders.institutions("AAPL")
print("Top Institutional Holders:")
for holder in institutions[:5]:
print(f"{holder['name']}: {holder['shares']:,} shares")
# Get insider transactions
transactions = client.insiders.transactions("AAPL")
print("
Recent Insider Transactions:")
for tx in transactions[:5]:
print(f"{tx['date']}: {tx['insider']} - {tx['transaction_type']}: {tx['shares']:,} shares")
# Get ownership breakdown
ownership = client.insiders.ownership("AAPL")
print(f"
Insiders: {ownership['insider_percent']}%")
print(f"Institutions: {ownership['institution_percent']}%")
print(f"Retail: {ownership['retail_percent']}%")Earnings API
client.earningsHistorical earnings data, trends, and estimates.
Available Methods
| Method | Description |
|---|---|
| history(ticker) | Get historical earnings data |
| trend(ticker) | Get earnings trend and estimates |
| index(ticker) | Get index trend estimates |
| report(ticker, year, quarter) | Get detailed earnings report for a specific period |
| transcript(ticker, year, quarter) | Get earnings call transcript for a ticker, year, and quarter |
| transcript_sentiment(id) | Get sentiment analysis of an earnings call transcript by its base64 ID |
Earnings API - Example
# Get earnings history
history = client.earnings.history("AAPL")
print("Earnings History:")
for period in history:
print(f"{period['date']}: EPS {period['eps']} vs {period['estimate']} est")
# Get earnings trend
trend = client.earnings.trend("AAPL")
print(f"
Current Quarter Estimate: {trend['current_quarter_estimate']}")
print(f"Next Quarter Estimate: {trend['next_quarter_estimate']}")
print(f"Current Year Estimate: {trend['current_year_estimate']}")
# Get specific quarterly report
q1_2024 = client.earnings.report("AAPL", year="2024", quarter="Q1")
print(f"
Q1 2024 Revenue: {q1_2024['revenue']:,.0f}")
print(f"Q1 2024 EPS: {q1_2024['eps']}")Economic API
client.econEconomic indicators, datasets, and calendar events.
Available Methods
| Method | Description |
|---|---|
| find(query) | Find economic series using natural language description |
| search(query) | Search for economic series |
| dataset(series_id) | Get series observations |
| calendar(from_date, to_date, country, min_importance, currency, category) | Get economic calendar with filters |
Economic API - Example
# Search for inflation series
inflation_series = client.econ.search("inflation")
for series in inflation_series:
print(f"{series['id']}: {series['name']}")
# Get GDP data
gdp = client.econ.dataset("GDP_USA")
print("
GDP History:")
for observation in gdp['observations'][-5:]:
print(f"{observation['date']}: {observation['value']}")
# Get important economic events
calendar = client.econ.calendar(
from_date="2024-04-01",
to_date="2024-04-30",
country="US",
min_importance=3
)
for event in calendar:
print(f"{event['date']}: {event['event']} - {event['importance']}/3")Sentiment API
client.sentimentSocial media sentiment, news sentiment, and analyst sentiment data.
Available Methods
| Method | Description |
|---|---|
| all(ticker) | Get combined sentiment (social + news + analyst) |
| social(ticker) | Get social media sentiment |
| news(ticker) | Get news sentiment |
| analyst(ticker) | Get analyst sentiment |
Sentiment API - Example
# Get overall sentiment
sentiment = client.sentiment.all("TSLA")
print(f"Overall Score: {sentiment['overall_score']}")
print(f"Sentiment: {sentiment['sentiment']}")
# Get social media sentiment
social = client.sentiment.social("TSLA")
print(f"
Social Media:")
print(f"Mentions: {social['mentions']}")
print(f"Positive: {social['positive_percent']}%")
print(f"Negative: {social['negative_percent']}%")
# Get analyst sentiment
analyst = client.sentiment.analyst("TSLA")
print(f"
Analyst Sentiment:")
print(f"Buy: {analyst['buy_count']}")
print(f"Hold: {analyst['hold_count']}")
print(f"Sell: {analyst['sell_count']}")News API
client.newsFinancial news articles by company, country, or category.
Available Methods
| Method | Description |
|---|---|
| general() | Get general financial news |
| company(ticker) | Get news for a specific company |
| country(country) | Get news for a specific country |
| category(category) | Get news by category |
News API - Example
# Get top general headlines
headlines = client.news.general()
print("Top Financial News:")
for article in headlines[:5]:
print(f"- {article['title']} ({article['source']})")
# Get company-specific news
aapl_news = client.news.company("AAPL")
print("
Apple News:")
for article in aapl_news[:3]:
print(f"{article['published_at']}: {article['title']}")
# Get news by category
earnings_news = client.news.category("earnings")
mergers_news = client.news.category("mergers")Supply Chain API
client.supply_chainCompany relationships including customers, suppliers, and industry peers.
Available Methods
| Method | Description |
|---|---|
| customers(ticker) | Get major customers |
| suppliers(ticker) | Get key suppliers |
| peers(ticker) | Get industry peers |
Supply Chain API - Example
# Get Apple's suppliers
suppliers = client.supply_chain.suppliers("AAPL")
print("Apple Suppliers:")
for supplier in suppliers[:5]:
print(f"- {supplier['name']} ({supplier['ticker']})")
# Get industry peers
peers = client.supply_chain.peers("AAPL")
print("
Industry Peers:")
for peer in peers:
print(f"- {peer['name']} ({peer['ticker']})")
# Get major customers
customers = client.supply_chain.customers("TSLA")
print("
Tesla Customers:")
for customer in customers:
print(f"- {customer['name']}")ETFs API
client.etfsComprehensive ETF data including fund information, holdings, and exposure analysis.
Available Methods
| Method | Description |
|---|---|
| tickers(country, exchange) | Get all ETF tickers with optional filtering |
| ticker(ticker) | Get a single ETF ticker by its symbol |
| quote(ticker) | Get a quote for an ETF by its symbol |
| prices(ticker, from_date, to_date, frame) | Get historical prices for an ETF |
| fund(ticker) | Get detailed fund data for an ETF |
| holdings(ticker) | Get holdings data for an ETF |
| exposure(ticker) | Get exposure data for an ETF holding |
| weights(ticker) | Get weights data for an ETF's components |
| gainers(days, limit) | Get top ETF gainers |
| losers(days, limit) | Get top ETF losers |
ETFs API - Example
# Get SPY fund information
spy = client.etfs.fund("SPY")
print(f"SPY - {spy['name']}")
print(f"AUM: {spy['aum']:,.0f}")
print(f"Expense Ratio: {spy['expense_ratio']}%")
print(f"Inception Date: {spy['inception_date']}")
# Get top holdings
holdings = client.etfs.holdings("SPY")
print("
Top Holdings:")
for holding in holdings[:5]:
print(f"{holding['name']}: {holding['weight']}%")
# Get sector exposure
exposure = client.etfs.exposure("SPY")
print("
Sector Exposure:")
for sector, weight in exposure['sectors'].items():
print(f"{sector}: {weight}%")Forex API
client.forexForeign exchange currency data including tickers, quotes, and historical prices.
Available Methods
| Method | Description |
|---|---|
| tickers(country, exchange) | Get all forex tickers with optional filtering |
| ticker(ticker) | Get a single forex ticker by its symbol |
| quote(ticker) | Get current quote for a forex pair |
| prices(ticker, from_date, to_date, frame) | Get historical prices for a forex pair |
| gainers(days, limit) | Get top forex gainers |
| losers(days, limit) | Get top forex losers |
Forex API - Example
# Get all major forex pairs
pairs = client.forex.tickers()
print("Major Forex Pairs:")
for pair in pairs[:5]:
print(f"- {pair['symbol']}: {pair['name']}")
# Get EUR/USD quote
eur_usd = client.forex.quote("EUR-USD")
print(f"
EUR/USD: {eur_usd['price']}")
print(f"Change: {eur_usd['change']}%")
print(f"Day Range: {eur_usd['day_low']} - {eur_usd['day_high']}")
# Get historical USD/JPY prices
usd_jpy = client.forex.prices(
"USD-JPY",
from_date="2024-01-01",
to_date="2024-03-31",
frame="daily"
)Futures API
client.futuresCommodity and financial futures data including tickers, quotes, and historical prices.
Available Methods
| Method | Description |
|---|---|
| tickers(exchange) | Get all futures tickers with optional filtering |
| ticker(ticker) | Get a single futures ticker by its symbol |
| quote(ticker) | Get current quote for a futures contract |
| prices(ticker, from_date, to_date, frame) | Get historical prices for a futures contract |
| gainers(days, limit) | Get top futures gainers |
| losers(days, limit) | Get top futures losers |
Futures API - Example
# Get all futures tickers
futures = client.futures.tickers()
print("Available Futures:")
for future in futures[:5]:
print(f"- {future['symbol']}: {future['name']}")
# Get gold futures quote
gold = client.futures.quote("GC=F")
print(f"
Gold Futures: {gold['price']}")
print(f"Settlement: {gold['settlement']}")
print(f"Open Interest: {gold['open_interest']}")
# Get crude oil futures prices
oil_prices = client.futures.prices(
"CL=F",
from_date="2024-01-01",
to_date="2024-03-31",
frame="daily"
)Indices API
client.indicesStock market indices data including tickers, quotes, and historical prices.
Available Methods
| Method | Description |
|---|---|
| tickers(exchange) | Get all index tickers with optional filtering |
| ticker(ticker) | Get a single index ticker by its symbol |
| quote(ticker) | Get current quote for an index |
| prices(ticker, from_date, to_date, frame) | Get historical prices for an index |
| gainers(days, limit) | Get top index gainers |
| losers(days, limit) | Get top index losers |
| components(ticker) | Get index components for a given index |
| exposure(ticker) | Get index exposure for a given index |
Indices API - Example
# Get all indices
indices = client.indices.tickers()
print("Major Indices:")
for index in indices[:5]:
print(f"- {index['symbol']}: {index['name']}")
# Get S&P 500 quote
spx = client.indices.quote("^GSPC")
print(f"
S&P 500: {spx['price']:,.2f}")
print(f"Change: {spx['change']}%")
print(f"YTD Change: {spx['ytd_change']}%")
# Get NASDAQ historical prices
nasdaq = client.indices.prices(
"^IXIC",
from_date="2024-01-01",
to_date="2024-03-31",
frame="daily"
)Credit API
client.creditCredit ratings and entity search for companies and financial instruments.
Available Methods
| Method | Description |
|---|---|
| search(query) | Search for credit entities |
| ratings(entity_id) | Get ratings for a specific credit entity |
Credit API - Example
# Search for credit entities
results = client.credit.search("Apple")
for entity in results:
print(f"{entity['name']} - {entity['entity_type']}")
# Get credit ratings for Apple
ratings = client.credit.ratings("AAPL")
print(f"
Apple Credit Ratings:")
print(f"Moody's: {ratings['moodys']}")
print(f"S&P: {ratings['sp']}")
print(f"Fitch: {ratings['fitch']}")
print(f"Outlook: {ratings['outlook']}")ESG API
client.esgEnvironmental, Social, and Governance (ESG) scores and metrics for publicly traded companies.
Available Methods
| Method | Description |
|---|---|
| data(ticker) | Get comprehensive ESG data for a specific company |
ESG API - Example
# Get ESG data for Microsoft
esg = client.esg.data("MSFT")
print(f"Overall ESG Score: {esg['score']}")
print(f"Environmental Score: {esg['environmental_score']}")
print(f"Environmental Grade: {esg['environmental_grade']}")
print(f"Social Score: {esg['social_score']}")
print(f"Social Grade: {esg['social_grade']}")
print(f"Governance Score: {esg['governance_score']}")
print(f"Governance Grade: {esg['governance_grade']}")
# Access detailed metrics
if 'controversies' in esg:
print(f"
Controversies: {len(esg['controversies'])}")
for metric in esg['key_metrics']:
print(f"{metric['name']}: {metric['value']}")Web Traffic API
client.web_trafficWebsite traffic and analytics data for publicly traded companies.
Available Methods
| Method | Description |
|---|---|
| traffic(ticker) | Get website traffic and analytics data |
Web Traffic API - Example
# Get web traffic data for Amazon
traffic = client.web_traffic.traffic("AMZN")
print(f"Monthly Visits: {traffic['monthly_visits']:,}")
print(f"Monthly Unique Visitors: {traffic['monthly_unique_visitors']:,}")
print(f"Pages per Visit: {traffic['pages_per_visit']}")
print(f"Average Visit Duration: {traffic['avg_visit_duration']}s")
print(f"Bounce Rate: {traffic['bounce_rate']}%")
# Traffic trends
print("
Traffic by Source:")
for source, percentage in traffic['traffic_sources'].items():
print(f"{source}: {percentage}%")
# Geographic distribution
print("
Top Countries:")
for country in traffic['top_countries'][:5]:
print(f"{country['name']}: {country['percentage']}%")Error Handling
The SDK raises descriptive exceptions that can be caught and handled gracefully.
Common Exceptions
| Error Pattern | Description |
|---|---|
| HTTP Error 4xx | Client error (invalid request, unauthorized, etc.) |
| HTTP Error 5xx | Server error (API temporarily unavailable) |
| Connection Error | Network failure or DNS resolution error |
| Timeout Error | Request exceeded timeout limit |
| Authentication Error | Missing or invalid API key |
Error handling with retry
import time
from axion import Axion
client = Axion(api_key="your_api_key_here")
def fetch_with_retry(func, *args, max_retries=3, base_delay=1):
"""Fetch data with exponential backoff retry logic."""
for attempt in range(max_retries):
try:
return func(*args)
except Exception as e:
error_str = str(e)
# Handle rate limiting (429)
if "429" in error_str and attempt < max_retries - 1:
delay = base_delay * (2 ** attempt)
print(f"Rate limited. Retrying in {delay}s...")
time.sleep(delay)
continue
# Handle authentication errors
elif "Authentication" in error_str or "401" in error_str:
print("Invalid API key. Please check your credentials.")
break
# Handle not found (404)
elif "404" in error_str:
print(f"Resource not found: {args}")
break
# Handle server errors (5xx)
elif "500" in error_str or "502" in error_str or "503" in error_str:
if attempt < max_retries - 1:
delay = base_delay * (2 ** attempt)
print(f"Server error. Retrying in {delay}s...")
time.sleep(delay)
continue
else:
print("API server unavailable. Please try again later.")
# Re-raise unexpected errors
else:
raise
return None
# Usage
data = fetch_with_retry(client.stocks.quote, "AAPL")
if data:
print(f"Price: {data['price']}")Data Normalization
All responses are automatically normalized: string numbers → int/float, "true"/"false" → bool, recursively. This means you can use the returned data directly without manual type conversion.
String → Number
"150.42" → 150.42 (float), "42" → 42 (int)
String → Boolean
"true"/"false" → True/False (case-insensitive)
Deep recursion
Nested dictionaries and lists are traversed and normalized
Null handling
"null", "None" remain as None/null values
Automatic type conversion
# Raw API returns:
# {
# "price": "150.42",
# "volume": "12345678",
# "active": "true",
# "pe_ratio": "25.6",
# "details": {
# "has_dividend": "false",
# "dividend_yield": "0.5"
# }
# }
# After normalization:
# {
# "price": 150.42,
# "volume": 12345678,
# "active": True,
# "pe_ratio": 25.6,
# "details": {
# "has_dividend": False,
# "dividend_yield": 0.5
# }
# }
# Use directly without casting:
data = client.stocks.quote("AAPL")
price = data['price'] # Already a float
volume = data['volume'] # Already an int
if data['active']: # Already a bool
print(f"Trading active with P/E {data['pe_ratio']}")Complete Example
A comprehensive script demonstrating multiple API calls, data analysis with pandas, and visualization.
#!/usr/bin/env python3
"""
Axion SDK Complete Example
Demonstrates multiple API endpoints and data analysis techniques
"""
from axion import Axion
import pandas as pd
import matplotlib.pyplot as plt
import seaborn as sns
from datetime import datetime, timedelta
import time
import SEOMetadata from '@/components/SEOMetadata';
class CompanyAnalyzer:
def __init__(self, api_key):
self.client = Axion(api_key=api_key)
def analyze_company(self, ticker):
"""Fetch and display comprehensive company data."""
print(f"\n{'='*60}")
print(f"COMPANY ANALYSIS: {ticker}")
print('='*60)
try:
# Profile information
profile = self.client.profiles.profile(ticker)
print(f"\n PROFILE:")
print(f" Name: {profile.get('name')}")
print(f" Sector: {profile.get('sector')}")
print(f" Industry: {profile.get('industry')}")
print(f" Employees: {profile.get('full_time_employees'):,}")
# Stock quote
quote = self.client.stocks.quote(ticker)
print(f"\n MARKET DATA:")
print(f" Price: {quote.get('price'):,.2f}")
print(f" Change: {quote.get('change')}%")
print(f" Volume: {quote.get('volume'):,}")
print(f" Market Cap: {quote.get('market_cap'):,.0f}")
# ESG data
esg = self.client.esg.data(ticker)
print(f"\n ESG SCORES:")
print(f" Overall: {esg.get('score')}")
print(f" Environmental: {esg.get('environmental_grade')}")
print(f" Social: {esg.get('social_grade')}")
print(f" Governance: {esg.get('governance_grade')}")
# Financial snapshot
snapshot = self.client.financials.snapshot(ticker)
print(f"\n FINANCIALS:")
print(f" Revenue (TTM): {snapshot.get('revenue_ttm'):,.0f}")
print(f" Gross Margin: {snapshot.get('gross_margin')}%")
print(f" Operating Margin: {snapshot.get('operating_margin')}%")
print(f" Debt/Equity: {snapshot.get('debt_to_equity')}")
# Sentiment
sentiment = self.client.sentiment.all(ticker)
print(f"\n SENTIMENT:")
print(f" Overall Score: {sentiment.get('overall_score')}")
print(f" Sentiment: {sentiment.get('sentiment')}")
# Recent news
news = self.client.news.company(ticker)
print(f"\n RECENT NEWS (Top 3):")
for article in news[:3]:
print(f" • {article.get('title')}")
print(f" {article.get('published_at')} - {article.get('source')}")
return {
'ticker': ticker,
'price': quote.get('price'),
'market_cap': quote.get('market_cap'),
'esg_score': esg.get('score'),
'sentiment_score': sentiment.get('overall_score'),
'revenue_ttm': snapshot.get('revenue_ttm'),
'gross_margin': snapshot.get('gross_margin')
}
except Exception as e:
print(f"Error analyzing {ticker}: {e}")
return None
def analyze_portfolio(self, tickers):
"""Analyze multiple companies and create comparison."""
results = []
for ticker in tickers:
result = self.analyze_company(ticker)
if result:
results.append(result)
time.sleep(1) # Rate limiting
if results:
df = pd.DataFrame(results)
print("\n" + "="*60)
print("PORTFOLIO COMPARISON")
print("="*60)
print(df.to_string(index=False))
# Create visualizations
fig, axes = plt.subplots(2, 2, figsize=(14, 10))
fig.suptitle('Portfolio Analysis', fontsize=16)
# Market Cap comparison
axes[0, 0].barh(df['ticker'], df['market_cap'])
axes[0, 0].set_xlabel('Market Cap ($B)')
axes[0, 0].set_title('Market Capitalization')
# ESG Scores
axes[0, 1].bar(df['ticker'], df['esg_score'], color='green')
axes[0, 1].set_ylabel('ESG Score')
axes[0, 1].set_title('ESG Scores')
# Sentiment
axes[1, 0].bar(df['ticker'], df['sentiment_score'], color='blue')
axes[1, 0].set_ylabel('Sentiment Score')
axes[1, 0].set_title('Sentiment Analysis')
# Margins
x = range(len(df))
width = 0.35
axes[1, 1].bar([i - width/2 for i in x], df['gross_margin'], width, label='Gross Margin', color='orange')
axes[1, 1].set_xticks(x)
axes[1, 1].set_xticklabels(df['ticker'])
axes[1, 1].set_ylabel('Margin %')
axes[1, 1].set_title('Profit Margins')
axes[1, 1].legend()
plt.tight_layout()
plt.show()
return df
return None
def historical_analysis(self, ticker, months=6):
"""Analyze historical price trends."""
end_date = datetime.now()
start_date = end_date - timedelta(days=30*months)
print(f"\n HISTORICAL ANALYSIS: {ticker}")
print(f"Period: {start_date.strftime('%Y-%m-%d')} to {end_date.strftime('%Y-%m-%d')}")
# Get historical prices
prices = self.client.stocks.prices(
ticker,
from_date=start_date.strftime('%Y-%m-%d'),
to_date=end_date.strftime('%Y-%m-%d'),
frame='daily'
)
if prices:
df = pd.DataFrame(prices)
df['date'] = pd.to_datetime(df['date'])
df.set_index('date', inplace=True)
# Calculate metrics
df['daily_return'] = df['close'].pct_change() * 100
df['sma_20'] = df['close'].rolling(window=20).mean()
df['sma_50'] = df['close'].rolling(window=50).mean()
# Print statistics
print(f"\n STATISTICS:")
print(f" Start Price: {df['close'].iloc[0]:.2f}")
print(f" End Price: {df['close'].iloc[-1]:.2f}")
print(f" Total Return: {((df['close'].iloc[-1] / df['close'].iloc[0]) - 1) * 100:.2f}%")
print(f" Max Price: {df['close'].max():.2f}")
print(f" Min Price: {df['close'].min():.2f}")
print(f" Volatility (daily): {df['daily_return'].std():.2f}%")
# Plot
fig, (ax1, ax2) = plt.subplots(2, 1, figsize=(12, 8))
# Price chart with moving averages
ax1.plot(df.index, df['close'], label='Close Price', linewidth=1)
ax1.plot(df.index, df['sma_20'], label='20-day SMA', linestyle='--', alpha=0.7)
ax1.plot(df.index, df['sma_50'], label='50-day SMA', linestyle='--', alpha=0.7)
ax1.set_ylabel('Price ($)')
ax1.set_title(f'{ticker} - Historical Prices')
ax1.legend()
ax1.grid(True, alpha=0.3)
# Daily returns histogram
ax2.hist(df['daily_return'].dropna(), bins=50, edgecolor='black', alpha=0.7)
ax2.set_xlabel('Daily Return (%)')
ax2.set_ylabel('Frequency')
ax2.set_title('Distribution of Daily Returns')
ax2.grid(True, alpha=0.3)
plt.tight_layout()
plt.show()
return df
return None
def main():
# Initialize
analyzer = CompanyAnalyzer(api_key="your_api_key_here")
# Analyze single company
analyzer.analyze_company("AAPL")
# Analyze portfolio
portfolio = ["AAPL", "MSFT", "GOOGL", "AMZN", "TSLA"]
analyzer.analyze_portfolio(portfolio)
# Historical analysis
analyzer.historical_analysis("AAPL", months=6)
if __name__ == "__main__":
main()Time Series Models
Statistical and machine learning models for time series forecasting and analysis.
linearRegression
linearRegression(df, x, target, n_preds=10, scale='D')Simple linear regression model for time series forecasting using scikit-learn's LinearRegression.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| df | pandas.DataFrame | Required | DataFrame containing time series data |
| x | string | Required | Column name for datetime values |
| target | string | Required | Column name for target variable to predict |
| n_preds | int | Optional | Number of future periods to predict (default: 10) |
| scale | string | Optional | pandas frequency string for future dates (default: 'D' for daily) |
Returns
Returns a pandas.DataFrame with two columns: the x column (future dates) and target column (predicted values).
Usage Example
Python
from axion import models
import pandas as pd
# Sample data
df = pd.DataFrame({
'date': pd.date_range('2023-01-01', periods=100, freq='D'),
'value': range(100)
})
# Make predictions
predictions = models.linearRegression(
df=df,
x='date',
target='value',
n_preds=5,
scale='D'
)
print(predictions)multiLinearRegression
multiLinearRegression(df, x, target, features, n_preds=10, scale='D')Multiple linear regression model that uses additional features for time series forecasting.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| df | pandas.DataFrame | Required | DataFrame containing time series data |
| x | string | Required | Column name for datetime values |
| target | string | Required | Column name for target variable to predict |
| features | list | Required | List of feature column names to use for prediction |
| n_preds | int | Optional | Number of future periods to predict (default: 10) |
| scale | string | Optional | pandas frequency string for future dates (default: 'D') |
Returns
Returns a pandas.DataFrame with 'time' and target columns containing future predictions.
Usage Example
Python
from axion import models
import pandas as pd
# Sample data with features
df = pd.DataFrame({
'date': pd.date_range('2023-01-01', periods=100, freq='D'),
'value': range(100),
'feature1': [i * 1.5 for i in range(100)],
'feature2': [i * 0.5 for i in range(100)]
})
# Make predictions using multiple features
predictions = models.multiLinearRegression(
df=df,
x='date',
target='value',
features=['feature1', 'feature2'],
n_preds=5,
scale='D'
)
print(predictions)beta
beta(df, x, y)Calculates the beta coefficient (slope) between two time series using linear regression.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| df | pandas.DataFrame | Required | DataFrame containing both time series |
| x | string | Required | Column name for dependent variable |
| y | string | Required | Column name for independent variable |
Returns
Returns a float representing the beta coefficient (regression slope) of x on y.
Usage Example
Python
from axion import models
import pandas as pd
# Sample data
df = pd.DataFrame({
'stock_returns': [0.01, 0.02, -0.01, 0.03, 0.01],
'market_returns': [0.005, 0.015, -0.005, 0.025, 0.01]
})
# Calculate beta coefficient
beta_value = models.beta(
df=df,
x='stock_returns',
y='market_returns'
)
print(f"Beta: {beta_value}")lstm
lstm(df, x, target, features=[], n_preds=10, scale='D')LSTM (Long Short-Term Memory) neural network for time series forecasting using TensorFlow/Keras.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| df | pandas.DataFrame | Required | DataFrame containing time series data |
| x | string | Required | Column name for datetime values |
| target | string | Required | Column name for target variable to predict |
| features | list | Optional | List of additional feature columns (default: empty list) |
| n_preds | int | Optional | Number of future periods to predict (default: 10) |
| scale | string | Optional | pandas frequency string for future dates (default: 'D') |
Returns
Returns a pandas.DataFrame with 'time' and target columns containing future predictions.
Helper Function
create_sequences(data, sequence_length, n_preds) - Creates sequences for LSTM training.
Usage Example
Python
from axion import models
import pandas as pd
import SEOMetadata from '@/components/SEOMetadata';
# Sample data
df = pd.DataFrame({
'date': pd.date_range('2023-01-01', periods=200, freq='D'),
'value': [i + 10 * (i % 7) for i in range(200)],
'feature': [i * 0.5 for i in range(200)]
})
# Make predictions using LSTM
predictions = models.lstm(
df=df,
x='date',
target='value',
features=['feature'],
n_preds=5,
scale='D'
)
print(predictions)