TypeScript¶

@bitpin-dev/bitpin-sdk on npm (published by the bitpin-dev npm organization): the same SDK for TypeScript and JavaScript, with ccxt JS names and the same behaviour as the Python SDK. Node 22 or newer; Bun and Deno work too. It's meant for servers and bots: API secrets don't belong in a browser.

npm install @bitpin-dev/bitpin-sdk

import { Bitpin, InsufficientFunds } from "@bitpin-dev/bitpin-sdk";

const client = new Bitpin({ apiKey: process.env.BITPIN_API_KEY, secret: process.env.BITPIN_SECRET_KEY });
const ticker = await client.fetchTicker("BTC/IRT");
console.log(ticker.last?.toString());

const order = await client.createOrder("USDT/IRT", "limit", "buy", "10", "90000", { clientOrderId: "bot-1" });
await client.cancelOrderByIdentifier("bot-1");

Without options, new Bitpin() reads BITPIN_API_KEY, BITPIN_SECRET_KEY and BITPIN_DOMAIN from the environment.

Supported versions¶

Runtime: Node.js 22 or newer ("engines" in package.json), tested on Node 22, 24 and 26. Bun and Deno also work.
Types: the declarations work with TypeScript 5.0 or newer; the SDK itself is built with TypeScript 7.
Contributors: use the Node version in ts/.nvmrc (nvm, fnm, mise and Volta read it). devEngines in package.json makes npm refuse Node older than 22 or npm older than 10.9.

Differences from Python¶

	Python	TypeScript
Clients	`Bitpin` (sync) and `AsyncBitpin`	one `Bitpin`; every method returns a `Promise`
Names	`fetch_order_book`	`fetchOrderBook` (ccxt JS)
Implicit API	`client.public_get_mkt_tickers()`	`client.publicGetMktTickers()`
Numbers	`decimal.Decimal`	`Decimal` from decimal.js, re-exported: `import { Decimal } from "@bitpin-dev/bitpin-sdk"`
`timeout`	seconds	milliseconds, as in ccxt JS
Bulk cancel	`cancel_orders(ids=[...])`	`cancelOrders({ ids: [...] })` or `{ identifiers: [...] }`
Token store	`FileTokenStore()`	`new FileTokenStore()` (Node), async `TokenStore` interface
WebSocket	both clients	built in

Methods¶

Markets: loadMarkets, market, fetchMarkets, fetchCurrencies, fetchNetworks, fetchMarketSuspensions, describe
Prices: fetchTicker, fetchTickers, fetchOrderBook, fetchTrades, fetchOHLCV (alias fetchOhlcv)
Fees: fetchTradingFees, fetchTradingFee
Orders: createOrder, createOrders, fetchOrder, fetchOrders, fetchOpenOrders, fetchClosedOrders, fetchOrderHistory, cancelOrder, cancelOrderByIdentifier, cancelOrders, fetchMyTrades
Wallet: fetchBalance, fetchBankAccounts, fetchDepositAddress, fetchCurrencyNetworks, fetchDeposits, fetchWithdrawals, withdraw, verifyWithdrawOtp, resendWithdrawOtp
WebSocket: watchTicker, watchOHLCV, watchOrderBook, watchTrades, watchOrders, watchMyTrades, and close to disconnect
Low level: request(endpointId, pathParams, params, body)
Not offered by Bitpin yet (they throw NotSupported): cancelAllOrders, editOrder, fetchAccounts, fetchLedger, transfer, fetchDepositWithdrawFees, fetchPositions, setLeverage, createDepositAddress, watchBalance, watchTickers, setSandboxMode

Arguments, limits and results are the same as on the market data, trading, wallet and WebSocket pages.

Configuration¶

const client = new Bitpin({
  apiKey: "...",
  secretKey: "...",            // or `secret`, as in ccxt
  domain: "org",               // "org" (default), "ir" or "market"; REST and WebSocket switch together
  timeout: 10_000,             // ms
  maxRetries: 3,               // idempotent requests only
  rateLimits: { orderbook: "10800/min" },
  tokenStore: new FileTokenStore(),
});

Errors¶

The classes are the same as in Python and ccxt, and are exported both directly and as errors:

import { errors, InsufficientFunds } from "@bitpin-dev/bitpin-sdk";

try {
  await client.createOrder("USDT/IRT", "limit", "buy", "10", "90000");
} catch (error) {
  if (error instanceof InsufficientFunds) { /* ... */ }
  if (error instanceof errors.RateLimitExceeded) console.log(error.retryAfter);
}

Examples¶

examples/ts/ has quickstart.ts, place-and-cancel.ts and market-maker.ts. They print the requests they would send unless you pass --live.

node --experimental-strip-types examples/ts/quickstart.ts --symbol BTC/IRT