TradingAPI TypeB TypeScript/JavaScript SDK

The official TypeScript/JavaScript client for communicating with the TypeB Trading API.

mStock TypeB is a comprehensive trading API that provides capabilities required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (WebSockets), and more.

Documentation

• TradingAPI documentation
• Examples
• Testing Guide

Requirements

• Node.js v18.0.0+

Installation

npm install

Install via npm

npm install @mstock-mirae-asset/nodetradingapi-typeb

Features

• Comprehensive API Coverage - Full support for all TypeB trading API endpoints
• TypeScript Support - Fully typed with TypeScript for better development experience
• Authentication - Built-in support for JWT token authentication
• Order Management - Place, modify, cancel orders with ease
• Portfolio Management - View positions, holdings, and trade history
• Market Data - Real-time quotes, historical data, and chart data
• WebSocket Support - Real-time market data streaming with MTicker
• Basket Orders - Create and manage basket orders
• Options Trading - Complete options chain support
• Error Handling - Comprehensive error handling and retry mechanisms

Getting started with API

Basic Setup

import { MConnect } from '@mstock-mirae-asset/nodetradingapi-typeb';

// Initialize the client
const client = new MConnect('https://api.mstock.trade', 'your-api-key');

// Login
const loginResponse = await client.login({
    clientcode: 'your-client-code',
    password: 'your-password',
    totp: 'your-totp',
    state: 'your-state'
});

// Set access token
client.setAccessToken(loginResponse.data.jwtToken);

Place an Order

const order = await client.placeOrder({
    variety: 'NORMAL',
    tradingsymbol: 'INFY',
    symboltoken: '1594',
    exchange: 'NSE',
    transactiontype: 'BUY',
    ordertype: 'LIMIT',
    quantity: '100',
    producttype: 'DELIVERY',
    price: '1500'
});

Authentication

The SDK supports JWT token authentication. After successful login, use the setAccessToken method to set the authentication token.

const loginResponse = await client.login({
    clientcode: 'your-client-code',
    password: 'your-password',
    totp: 'your-totp',
    state: 'your-state'
});

client.setAccessToken(loginResponse.data.jwtToken);

Usage Examples

Order Management

// Place an order
const order = await client.placeOrder({
    variety: 'NORMAL',
    tradingsymbol: 'INFY',
    symboltoken: '1594',
    exchange: 'NSE',
    transactiontype: 'BUY',
    ordertype: 'LIMIT',
    quantity: '100',
    producttype: 'DELIVERY',
    price: '1500'
});

// Modify an order
const modifiedOrder = await client.modifyOrder({
    variety: 'NORMAL',
    orderid: '123456',
    tradingsymbol: 'INFY',
    symboltoken: '1594',
    exchange: 'NSE',
    ordertype: 'MARKET',
    quantity: '50',
    producttype: 'DELIVERY'
});

// Cancel an order
await client.cancelOrder({
    variety: 'NORMAL',
    orderid: '123456'
});

Portfolio Management

// Get positions
const positions = await client.getPositions();

// Get holdings
const holdings = await client.getHoldings();

// Get fund summary
const fundSummary = await client.getFundSummary();

Market Data

// Get historical data
const historicalData = await client.getHistoricalData({
    exchange: 'NSE',
    symboltoken: '1594',
    interval: 'ONE_MINUTE',
    fromdate: '2024-01-01',
    todate: '2024-01-31'
});

// Get real-time quotes
const quotes = await client.getQuote({
    mode: 'FULL',
    exchangeTokens: {
        NSE: ['1594', '2885'],
        BSE: ['500325', '500209']
    }
});

Basket Orders

// Create basket
const basket = await client.createBasket({
    BaskName: 'MyStrategy',
    BaskDesc: 'My trading strategy basket'
});

// Calculate basket
const calculation = await client.calculateBasket({
    basket_name: 'MyStrategy',
    basket_id: '123',
    operation: 'CALCULATE',
    include_exist_pos: 'Y'
});

WebSocket Market Data

import { MTicker } from '@mstock-mirae-asset/nodetradingapi-typeb';

// Initialize MTicker
const ticker = new MTicker(apiKey, accessToken, 'wss://ws.mstock.trade', true);

// Event handlers
ticker.on('ticks', (ticks) => {
    console.log('Market data:', ticks);
});

ticker.on('connect', () => {
    ticker.sendLoginAfterConnect();
    // Subscribe to instruments with different modes
    ticker.subscribe('NSE', ['1594'], MTicker.MODE_LTP);    // LTP only
    ticker.subscribe('NSE', ['2885'], MTicker.MODE_QUOTE);  // OHLC + Volume
    ticker.subscribe('NSE', ['1333'], MTicker.MODE_SNAP);   // Full market depth
});

ticker.on('order_update', (data) => {
    console.log('Order update:', data);
});

ticker.on('trade_update', (data) => {
    console.log('Trade update:', data);
});

// Connect to WebSocket
ticker.connect();

API Reference

Authentication

| Method | Description | |--------|-------------| | login() | User authentication | | verifyOTP() | Verify OTP for session token | | verifyTOTP() | Verify TOTP for 2FA | | logout() | User logout |

Order Management

| Method | Description | |--------|-------------| | placeOrder() | Place new orders | | modifyOrder() | Modify existing orders | | cancelOrder() | Cancel orders | | cancelAllOrders() | Cancel all open orders | | getOrderBook() | Get order book | | getOrderDetails() | Get specific order details |

Portfolio Operations

| Method | Description | |--------|-------------| | getPositions() | Get open positions | | getHoldings() | Get portfolio holdings | | getFundSummary() | Get fund summary | | convertPosition() | Convert position between product types | | getTradeBook() | Get trade book | | getTradeHistory() | Get trade history |

Market Data

| Method | Description | |--------|-------------| | getHistoricalData() | Get historical candlestick data | | getIntradayChartData() | Get intraday chart data | | getQuote() | Get real-time quotes | | getInstrumentMaster() | Get instrument master data | | loserGainer() | Get top gainers and losers |

Options Trading

| Method | Description | |--------|-------------| | getOptionChainMaster() | Get option chain master data | | getOptionChain() | Get detailed option chain data |

Basket Operations

| Method | Description | |--------|-------------| | createBasket() | Create new basket | | fetchBasket() | Fetch existing baskets | | renameBasket() | Rename basket | | deleteBasket() | Delete basket | | calculateBasket() | Calculate basket margin and charges |

WebSocket (MTicker)

| Method | Description | |--------|-------------| | connect() | Connect to WebSocket | | subscribe() | Subscribe to instruments | | unsubscribe() | Unsubscribe from instruments | | sendLoginAfterConnect() | Send login after connection | | close() | Close WebSocket connection |

Other Operations

| Method | Description | |--------|-------------| | orderMargin() | Calculate order margin requirements |

Testing

The SDK includes comprehensive testing utilities:

Interactive API Testing

# Run interactive test menu
npx ts-node test/test-api.ts

WebSocket Testing

# Test real-time market data
npx ts-node test/test-ticker.ts

Available Test Categories

• Authentication: Login, OTP verification, TOTP verification
• Order Management: Place, modify, cancel orders
• Portfolio & Funds: Positions, holdings, fund summary
• Market Data: Historical data, quotes, instrument master
• WebSocket: Real-time market data streaming
• Basket Operations: Create, manage, calculate baskets
• Options Trading: Option chain data

See test/RUNTEST.md for detailed testing instructions.

Building

npm run build

License

MIT License - see LICENSE file for details.

mStock By Mirae Asset Capital Markets (India) Pvt. Ltd. (c) 2025. Licensed under the MIT License.

Support

For issues, please open an issue on GitHub.

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a new branch (feature-xyz)
3. Commit your changes
4. Push the branch and create a pull request