TypeScript SDK

polynode-sdk is the Node.js client for PolyNode’s V3 API, event stream, PN1 orderbook, perps stream, short-form markets, and trading helpers.

Install

npm install polynode-sdk@^0.12.2 ws

Node.js 18 or newer is required. The package supports ESM imports and CommonJS runtime loading. The examples use ESM.

package.json

{
  "type": "module"
}

Keep your key server-side:

export POLYNODE_API_KEY="pn_live_..."

First request

import { PolyNode } from 'polynode-sdk';

const apiKey = process.env.POLYNODE_API_KEY;
if (!apiKey) throw new Error('Set POLYNODE_API_KEY');

const pn = new PolyNode({ apiKey });
const stats = await pn.v3.stats();
console.log(stats);

Client surfaces

Entry point	Use it for
`pn.v3`	Complete V3 API registry and typed convenience methods
`pn.ws`	Settlements, confirmations, Chainlink prices, combos, and other events
`pn.orderbook`	Raw orderbook messages
`new OrderbookEngine(...)`	Managed local books and PN1 integrity
`pn.perps`	Managed V3 perps WebSocket
`pn.ws.shortForm(...)`	Rotating 5m, 15m, 1h, and 4h crypto markets
`new PolyNodeTrader(...)`	Current V2 order and position operations

Each WebSocket is independent. Close the subscription or client you opened when your process shuts down.

V3 API

Call any registered V3 operation.

Settlement stream

Subscribe with replay and overflow visibility.

Short-form and TWAP

Rotate with the correct Chainlink window.

PN1 orderbook

Maintain fail-closed local state.

Perps stream

Subscribe to tickers, books, trades, and klines.

Trading and fees

Use the current V2 defaults safely.

Getting Started

Core Guides

Optional Helpers

TypeScript

Python

Rust

Charts (Browser)

Install

First request

Client surfaces

V3 API

Settlement stream

Short-form and TWAP

PN1 orderbook

Perps stream

Trading and fees

​Install

​First request

​Client surfaces

V3 API

Settlement stream

Short-form and TWAP

PN1 orderbook

Perps stream

Trading and fees

Install

First request

Client surfaces