MetaScalp.Sdk 1.0.6

MetaScalp SDK

Official SDK for MetaScalp API — connect your trading bots and scripts to the MetaScalp terminal via REST and WebSocket.

MetaScalp exposes a local API that lets you query exchange data, execute trades, and stream real-time market data (trades, order book) and account updates (orders, positions, balances).

Available SDKs

Quick Start

JavaScript / TypeScript

import { MetaScalpClient, MetaScalpSocket } from 'metascalp';

// REST — discover MetaScalp and query data
const client = await MetaScalpClient.discover();
const { connections } = await client.getConnections();
const conn = connections[0];

// Place a limit buy order
await client.placeOrder(conn.id, {
  ticker: 'BTCUSDT',
  side: 1,
  price: 65000,
  size: 0.01,
  type: 0
});

// WebSocket — stream real-time updates
const socket = await MetaScalpSocket.discover();

// Connection-level: orders, positions, balances for ALL tickers on this connection
socket.subscribe(conn.id);
socket.on('order_update', (data) => console.log('Order:', data));
socket.on('position_update', (data) => console.log('Position:', data));
socket.on('balance_update', (data) => console.log('Balance:', data));

// Market data: trades and order book for a SPECIFIC ticker (independent from subscribe)
socket.subscribeTrades(conn.id, 'BTCUSDT');
socket.on('trade_update', (data) => console.log('Trade:', data));

socket.subscribeOrderBook(conn.id, 'BTCUSDT');
socket.on('orderbook_snapshot', (data) => console.log('OB Snapshot:', data));
socket.on('orderbook_update', (data) => console.log('OB Update:', data));

Python

import asyncio
from metascalp import MetaScalpClient, MetaScalpSocket

async def main():
    # REST
    client = await MetaScalpClient.discover()
    connections = await client.get_connections()
    conn = connections['connections'][0]

    # Place order
    await client.place_order(conn['id'], ticker='BTCUSDT', side=1, price=65000, size=0.01)

    # WebSocket
    socket = await MetaScalpSocket.discover()

    # Connection-level events (from subscribe) — all tickers
    @socket.on('order_update')
    def on_order(data):
        print(f"Order: {data['ticker']} {data['side']} {data['status']}")

    @socket.on('balance_update')
    def on_balance(data):
        print(f"Balance: {data}")

    # Market data events (from subscribe_trades / subscribe_order_book) — specific ticker
    @socket.on('trade_update')
    def on_trade(data):
        print(f"Trade: {data}")

    @socket.on('orderbook_snapshot')
    def on_snapshot(data):
        print(f"Snapshot: {len(data['asks'])} asks, {len(data['bids'])} bids")

    # Connection-level: orders, positions, balances for ALL tickers
    socket.subscribe(conn['id'])

    # Market data: trades and order book for a SPECIFIC ticker (independent from subscribe)
    socket.subscribe_trades(conn['id'], 'BTCUSDT')
    socket.subscribe_order_book(conn['id'], 'BTCUSDT')

    await socket.listen_forever()

asyncio.run(main())

C# / .NET

using MetaScalp.Sdk;

// REST
var client = await MetaScalpClient.DiscoverAsync();
var connections = await client.GetConnectionsAsync();
var conn = connections.First();

await client.PlaceOrderAsync(conn.Id, new PlaceOrderRequest
{
    Ticker = "BTCUSDT",
    Side = 1,
    Price = 65000m,
    Size = 0.01m,
    Type = 0
});

// WebSocket
var socket = await MetaScalpSocket.DiscoverAsync();

// Connection-level events (from Subscribe) — all tickers
socket.OnOrderUpdate += (data) => Console.WriteLine($"Order: {data.Ticker} {data.Side} {data.Status}");
socket.OnBalanceUpdate += (data) => Console.WriteLine($"Balance updated");

// Market data events (from SubscribeTrades / SubscribeOrderBook) — specific ticker
socket.OnTradeUpdate += (data) => Console.WriteLine($"Trade: {data.Ticker} {data.Trades.Count} trades");
socket.OnOrderBookSnapshot += (data) => Console.WriteLine($"OB: {data.Asks.Count} asks, {data.Bids.Count} bids");

// Connection-level: orders, positions, balances for ALL tickers
socket.Subscribe(conn.Id);

// Market data: trades and order book for a SPECIFIC ticker (independent from Subscribe)
socket.SubscribeTrades(conn.Id, "BTCUSDT");
socket.SubscribeOrderBook(conn.Id, "BTCUSDT");

API Overview

REST Endpoints

WebSocket Messages

Connection-level — subscribe by connectionId:

Market data — subscribe by connectionId + ticker:

Mass-subscribe optimization. orderbook_subscribe accepts an optional fetchSnapshot field (default true). Pass false to skip the exchange REST snapshot fetch when subscribing — useful when subscribing to 100+ tickers at once without hitting exchange REST rate limits. Seed state separately via GET /api/connections/{id}/orderbook-snapshot when you need it. A later subscriber that wants a snapshot triggers a lazy fetch that fans out to all listeners.

Connection Details

• Host: 127.0.0.1 (localhost only)
• Port range: 17845–17855 (first available, shared by HTTP and WebSocket)
• Both REST and WebSocket run on the same port — no separate socket port
• All SDKs include auto-discovery that scans the port range

License

MIT