@axionquant/sdk 1.0.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axionquant/sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Axion SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -5,7 +5,7 @@ A TypeScript/JavaScript SDK for the Axion financial data API.
 ## Installation
 
 ```bash
-npm install axion-sdk
+npm install @axionquant/sdk
 ```
 
 ## Quick Start
@@ -17,7 +17,7 @@ import { Axion } from 'axion-sdk';
 const client = new Axion('your-api-key');
 
 // Get stock price data
-const prices = await client.getStockPrices('AAPL', {
+const prices = await client.stocks.prices('AAPL', {
   from: '2024-01-01',
   to: '2024-12-31'
 });
@@ -43,56 +43,56 @@ const client = new Axion();
 
 ```typescript
 // Search for credit entities
-await client.searchCredit('Apple Inc');
+await client.credit.search('Apple Inc');
 
 // Get credit ratings for an entity
-await client.getCreditRatings('entity-id');
+await client.credit.ratings('entity-id');
 ```
 
 ### ESG
 
 ```typescript
 // Get ESG data for a stock
-await client.getEsgData('AAPL');
+await client.esg.data('AAPL');
 ```
 
 ### ETFs
 
 ```typescript
 // Get ETF fund data
-await client.getEtfFundData('SPY');
+await client.etfs.fund('SPY');
 
 // Get ETF holdings
-await client.getEtfHoldings('SPY');
+await client.etfs.holdings('SPY');
 
 // Get ETF exposure data
-await client.getEtfExposure('SPY');
+await client.etfs.exposure('SPY');
 ```
 
 ### Supply Chain
 
 ```typescript
 // Get company customers
-await client.getSupplyChainCustomers('AAPL');
+await client.supplyChain.customers('AAPL');
 
 // Get company peers
-await client.getSupplyChainPeers('AAPL');
+await client.supplyChain.peers('AAPL');
 
 // Get company suppliers
-await client.getSupplyChainSuppliers('AAPL');
+await client.supplyChain.suppliers('AAPL');
 ```
 
 ### Stocks
 
 ```typescript
 // Get all stock tickers
-await client.getStockTickers({ country: 'US', exchange: 'NASDAQ' });
+await client.stocks.tickers({ country: 'US', exchange: 'NASDAQ' });
 
 // Get ticker information
-await client.getStockTickerBySymbol('AAPL');
+await client.stocks.ticker('AAPL');
 
 // Get historical prices
-await client.getStockPrices('AAPL', {
+await client.stocks.prices('AAPL', {
   from: '2024-01-01',
   to: '2024-12-31',
   frame: '1d' // daily
@@ -103,13 +103,13 @@ await client.getStockPrices('AAPL', {
 
 ```typescript
 // Get all crypto tickers
-await client.getCryptoTickers({ type: 'coin' });
+await client.crypto.tickers({ type: 'coin' });
 
 // Get crypto ticker information
-await client.getCryptoTickerBySymbol('BTC');
+await client.crypto.ticker('BTC');
 
 // Get crypto prices
-await client.getCryptoPrices('BTC', {
+await client.crypto.prices('BTC', {
   from: '2024-01-01',
   to: '2024-12-31',
   frame: '1h'
@@ -120,13 +120,13 @@ await client.getCryptoPrices('BTC', {
 
 ```typescript
 // Get forex tickers
-await client.getForexTickers({ country: 'US' });
+await client.forex.tickers({ country: 'US' });
 
 // Get forex ticker information
-await client.getForexTickerBySymbol('EURUSD');
+await client.forex.ticker('EURUSD');
 
 // Get forex prices
-await client.getForexPrices('EURUSD', {
+await client.forex.prices('EURUSD', {
   from: '2024-01-01',
   to: '2024-12-31'
 });
@@ -136,13 +136,13 @@ await client.getForexPrices('EURUSD', {
 
 ```typescript
 // Get futures tickers
-await client.getFuturesTickers({ exchange: 'CME' });
+await client.futures.tickers({ exchange: 'CME' });
 
 // Get futures ticker information
-await client.getFuturesTickerBySymbol('ES');
+await client.futures.ticker('ES');
 
 // Get futures prices
-await client.getFuturesPrices('ES', {
+await client.futures.prices('ES', {
   from: '2024-01-01',
   to: '2024-12-31'
 });
@@ -152,13 +152,13 @@ await client.getFuturesPrices('ES', {
 
 ```typescript
 // Get index tickers
-await client.getIndexTickers({ exchange: 'NYSE' });
+await client.indices.tickers({ exchange: 'NYSE' });
 
 // Get index ticker information
-await client.getIndexTickerBySymbol('SPX');
+await client.indices.ticker('SPX');
 
 // Get index prices
-await client.getIndexPrices('SPX', {
+await client.indices.prices('SPX', {
   from: '2024-01-01',
   to: '2024-12-31'
 });
@@ -168,92 +168,94 @@ await client.getIndexPrices('SPX', {
 
 ```typescript
 // Search for economic datasets
-await client.searchEcon('unemployment rate');
+await client.econ.search('unemployment rate');
 
 // Get economic dataset
-await client.getEconDataset('UNRATE');
+await client.econ.dataset('UNRATE');
 
 // Get economic calendar
-await client.getEconCalendar({
+await client.econ.calendar({
   from: '2024-01-01',
   to: '2024-12-31',
   country: 'US',
-  minImportance: 3
+  minImportance: 3,
+  currency: 'USD',
+  category: 'employment'
 });
 ```
 
-### Company Profiles
+### News
 
 ```typescript
-// Asset profile
-await client.getStockAsset('AAPL');
+// Get latest general news
+await client.news.general();
 
-// Recommendations
-await client.getStockRecommendation('AAPL');
+// Get company-specific news
+await client.news.company('AAPL');
 
-// Financial statements
-await client.getStockCashflow('AAPL');
-await client.getStockIncome('AAPL');
-await client.getStockBalancesheet('AAPL');
-await client.getStockFinancials('AAPL');
+// Get country news
+await client.news.country('US');
 
-// Company statistics
-await client.getStockStatistics('AAPL');
-await client.getStockSummary('AAPL');
-await client.getStockInfo('AAPL');
+// Get category news
+await client.news.category('technology');
+```
 
-// Ownership and holders
-await client.getStockFund('AAPL');
-await client.getStockInsiders('AAPL');
-await client.getStockInstitution('AAPL');
-await client.getStockOwnership('AAPL');
+### Sentiment
 
-// Earnings and trends
-await client.getStockEarnings('AAPL');
-await client.getStockTrendEarnings('AAPL');
-await client.getStockTrendIndex('AAPL');
+```typescript
+// Get all sentiment data
+await client.sentiment.all('AAPL');
 
-// Insider activity
-await client.getStockActivity('AAPL');
-await client.getStockTransactions('AAPL');
+// Get social media sentiment
+await client.sentiment.social('AAPL');
 
-// Calendar events
-await client.getStockCalendar('AAPL');
+// Get news sentiment
+await client.sentiment.news('AAPL');
 
-// Web traffic
-await client.getStockTraffic('AAPL');
+// Get analyst sentiment
+await client.sentiment.analyst('AAPL');
 ```
 
-### News
+### Company Profiles
 
 ```typescript
-// Get latest news
-await client.getNews();
+// Asset profile
+await client.profiles.asset('AAPL');
 
-// Get company-specific news
-await client.getCompanyNews('AAPL');
+// Recommendations
+await client.profiles.recommendation('AAPL');
 
-// Get country news
-await client.getCountryNews('US');
+// Financial statements
+await client.profiles.cashflow('AAPL');
+await client.profiles.income('AAPL');
+await client.profiles.balancesheet('AAPL');
+await client.profiles.financials('AAPL');
 
-// Get category news
-await client.getCategoryNews('technology');
-```
+// Company statistics
+await client.profiles.statistics('AAPL');
+await client.profiles.summary('AAPL');
+await client.profiles.info('AAPL');
 
-### Sentiment
+// Ownership and holders
+await client.profiles.fund('AAPL');
+await client.profiles.insiders('AAPL');
+await client.profiles.institutionOwnership('AAPL');
+await client.profiles.ownership('AAPL');
 
-```typescript
-// Get all sentiment data
-await client.getSentimentAll('AAPL');
+// Earnings and trends
+await client.profiles.earnings('AAPL');
+await client.profiles.earningsTrend('AAPL');
+await client.profiles.indexTrend('AAPL');
 
-// Get social media sentiment
-await client.getSentimentSocial('AAPL');
+// Insider activity
+await client.profiles.activity('AAPL');
+await client.profiles.transactions('AAPL');
 
-// Get news sentiment
-await client.getSentimentNews('AAPL');
+// Calendar events
+await client.profiles.calendar('AAPL');
 
-// Get analyst sentiment
-await client.getSentimentAnalyst('AAPL');
+// Web traffic
+await client.profiles.traffic('AAPL');
 ```
 
 ## Error Handling
@@ -262,7 +264,7 @@ The SDK throws errors for failed requests. Use try-catch blocks to handle them:
 
 ```typescript
 try {
-  const data = await client.getStockPrices('AAPL');
+  const data = await client.stocks.prices('AAPL');
   console.log(data);
 } catch (error) {
   console.error('Error fetching data:', error.message);
@@ -279,4 +281,4 @@ import { Axion, ApiResponse } from 'axion-sdk';
 
 ## Base URL
 
-By default, the SDK connects to `http://localhost:3001`. To use a different base URL, modify the `BASE_URL` constant in the source code.
+By default, the SDK connects to `https://api.axionquant.com`. To use a different base URL, modify the `BASE_URL` constant in the source code.