Token Metrics AI API TypeScript SDK

The official TypeScript SDK for Token Metrics AI API - providing professional investors and traders with comprehensive cryptocurrency analysis, AI-powered trading signals, market data, and advanced insights.

Features

• Comprehensive Market Data: Access detailed information on thousands of cryptocurrencies
• AI-Powered Analysis: Get trading and investment grades based on advanced AI models
• Technical Indicators: Access technical analysis grades and quantitative metrics
• Price Data: Retrieve historical OHLCV (Open, High, Low, Close, Volume) data
• Trading Signals: Receive AI-generated long and short trading signals
• AI Agent: Interact with Token Metrics' AI chatbot for market insights
• AI Reports: Access detailed technical, fundamental, and trading reports
• Simple Interface: Intuitive API with Express.js integration
• JavaScript & TypeScript Compatible: Works with both JavaScript and TypeScript projects

Installation

npm install tmai-api

You can find the package on npm at: tmai-api

Quick Start

TypeScript Usage

import { TokenMetricsClient } from 'tmai-api';

// Initialize the client with your API key
const client = new TokenMetricsClient('your-api-key');

// Get information for top cryptocurrencies
client.tokens.get({ symbol: 'BTC,ETH' })
  .then(tokens => {
    console.log(tokens);
  });

// Get short-term trading grades
client.traderGrades.get({
  symbol: 'BTC,ETH',
  startDate: '2023-10-01',
  endDate: '2023-10-10'
})
  .then(traderGrades => {
    console.log(traderGrades);
  });

// Get long-term investment grades
client.investorGrades.get({
  symbol: 'BTC,ETH',
  startDate: '2023-10-01',
  endDate: '2023-10-10'
})
  .then(investorGrades => {
    console.log(investorGrades);
  });

// Ask the AI agent a question
client.aiAgent.ask('What is your analysis of Bitcoin?')
  .then(answer => {
    console.log(answer);
  });

// Get hourly trading signals
client.hourlyTradingSignals.get({
  token_id: '3375', // Bitcoin token ID
  limit: 10,
  page: 1
})
  .then(signals => {
    console.log(signals);
  });

// Get indices overview
client.indices.get({ indicesType: 'active' })
  .then(indices => {
    console.log(indices);
  });

// Get indices holdings
client.indicesHoldings.get({ id: 'crypto-index-1' })
  .then(holdings => {
    console.log(holdings);
  });

// Get indices performance
client.indicesPerformance.get({
  id: 'crypto-index-1',
  startDate: '2023-10-01',
  endDate: '2023-10-10'
})
  .then(performance => {
    console.log(performance);
  });

// Using async/await with type annotations
async function getTokenData(): Promise<void> {
  const tokens = await client.tokens.get({ symbol: 'BTC,ETH' });
  console.log(tokens);
}

JavaScript Usage

// ES Modules
import { TokenMetricsClient } from 'tmai-api';

// OR CommonJS
// const { TokenMetricsClient } = require('tmai-api');

// Initialize the client with your API key
const client = new TokenMetricsClient('your-api-key');

// Get information for top cryptocurrencies
client.tokens.get({ symbol: 'BTC,ETH' })
  .then(tokens => {
    console.log(tokens);
  });

// Get short-term trading grades
client.traderGrades.get({
  symbol: 'BTC,ETH',
  startDate: '2023-10-01',
  endDate: '2023-10-10'
})
  .then(traderGrades => {
    console.log(traderGrades);
  });

// Get hourly trading signals
client.hourlyTradingSignals.get({
  token_id: '3375', 
  limit: 20
})
  .then(signals => {
    console.log(signals);
  });

// Using async/await
async function getTokenData() {
  const tokens = await client.tokens.get({ symbol: 'BTC,ETH' });
  console.log(tokens);
}

Available Endpoints

Endpoint	Description	Example
tokens	Information about all supported tokens	client.tokens.get({ symbol: 'BTC,ETH' })
hourlyOhlcv	Hourly price and volume data	client.hourlyOhlcv.get({ symbol: 'BTC', startDate: '2023-10-01', endDate: '2023-10-10' })
dailyOhlcv	Daily price and volume data	client.dailyOhlcv.get({ symbol: 'BTC', startDate: '2023-10-01', endDate: '2023-10-10' })
investorGrades	Long-term investment ratings	client.investorGrades.get({ symbol: 'BTC,ETH', startDate: '2023-10-01', endDate: '2023-10-10' })
traderGrades	Short-term trading signals	client.traderGrades.get({ symbol: 'BTC,ETH', startDate: '2023-10-01', endDate: '2023-10-10' })
marketMetrics	Overall market data	client.marketMetrics.get({ startDate: '2023-10-01', endDate: '2023-10-10' })
aiAgent	Interact with Token Metrics AI chatbot	client.aiAgent.ask('What is your Bitcoin forecast?')
aiReports	AI-generated analysis reports	client.aiReports.get({ symbol: 'BTC,ETH' })
tradingSignals	AI-generated trading signals	client.tradingSignals.get({ symbol: 'BTC,ETH', startDate: '2023-10-01', endDate: '2023-10-10', signal: '1' })
hourlyTradingSignals	Hourly AI-generated trading signals	client.hourlyTradingSignals.get({ token_id: '3375'})
cryptoInvestors	Information about crypto investors	client.cryptoInvestors.get()
topMarketCapTokens	Top tokens by market capitalization	client.topMarketCapTokens.get({ top_k: 100 })
resistanceSupport	Resistance and support levels	client.resistanceSupport.get({ symbol: 'BTC' })
price	Historical price data	client.price.get({ symbol: 'BTC', startDate: '2023-10-01', endDate: '2023-10-10' })
sentiment	Market sentiment data	client.sentiment.get({ symbol: 'BTC', startDate: '2023-10-01', endDate: '2023-10-10' })
quantmetrics	Quantitative metrics	client.quantmetrics.get({ symbol: 'BTC', startDate: '2023-10-01', endDate: '2023-10-10' })
scenarioAnalysis	Market scenario analysis	client.scenarioAnalysis.get({ symbol: 'BTC' })
correlation	Asset correlation data	client.correlation.get({ base_symbol: 'BTC', quote_symbol: 'ETH', startDate: '2023-10-01', endDate: '2023-10-10' })
indices	Overview of active/passive indices	client.indices.get({ indicesType: 'active' })
indicesHoldings	Token holdings with icons, weight, and market cap	client.indicesHoldings.get({ id: 'index_id' })
indicesPerformance	Index performance across different timeframes	client.indicesPerformance.get({ id: 'index_id', startDate: '2023-10-01', endDate: '2023-10-10' })
moonshotTokens	Get AI-curated token picks with high breakout potential	client.moonshotTokens.get({ type: 'active' })

Authentication

All API requests require an API key. You can get your API key by signing up at Token Metrics.

// Initialize with your API key
const client = new TokenMetricsClient('your-api-key');

Error Handling

The SDK provides built-in error handling for API requests:

client.tokens.get({ symbol: 'INVALID_SYMBOL' })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error:', error.message);
    // Handle the error appropriately
  });

// Using async/await with try/catch
async function getTokenData(): Promise<void> {
  try {
    const data = await client.tokens.get({ symbol: 'INVALID_SYMBOL' });
    console.log(data);
  } catch (error: unknown) {
    if (error instanceof Error) {
      console.error('Error:', error.message);
    } else {
      console.error('Unknown error:', error);
    }
    // Handle the error appropriately
  }
}

Requirements

• Node.js 14+
• axios package
• express package

Express.js Integration

This SDK can be easily integrated with Express.js to create your own API endpoints that leverage Token Metrics data:

import express from 'express';
import cors from 'cors';
import { TokenMetricsClient } from 'tmai-api';

// Initialize the Token Metrics client
const tmClient = new TokenMetricsClient('your-api-key');

// Create Express app
const app = express();
const port = 3000;

// Middleware
app.use(cors());
app.use(express.json());

// Get tokens endpoint
app.get('/api/tokens/:symbol', async (req, res) => {
  try {
    const { symbol } = req.params;
    const result = await tmClient.tokens.get({ symbol });
    res.json(result);
  } catch (error) {
    if (error instanceof Error) {
      res.status(500).json({ error: error.message });
    } else {
      res.status(500).json({ error: 'Unknown error occurred' });
    }
  }
});

// Get trading signals endpoint
app.get('/api/trading-signals/:symbol', async (req, res) => {
  try {
    const { symbol } = req.params;
    const { startDate, endDate, signal } = req.query;
    
    const result = await tmClient.tradingSignals.get({
      symbol,
      startDate: startDate as string | undefined,
      endDate: endDate as string | undefined,
      signal: signal as string | undefined
    });
    
    res.json(result);
  } catch (error) {
    if (error instanceof Error) {
      res.status(500).json({ error: error.message });
    } else {
      res.status(500).json({ error: 'Unknown error occurred' });
    }
  }
});

// Start the server
app.listen(port, () => {
  console.log(`Server running at http://localhost:${port}`);
});

For a complete Express.js server example, see the examples/express-server.js file.

Documentation

For complete API documentation, visit:

• Token Metrics API Documentation

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This SDK is distributed under the MIT License. See the LICENSE file for details.

---

Empowering investors with AI-powered crypto insights