Skip to main content
@parlayx/sdk is the official TypeScript client for the ParlayX API. It provides typed request and response models generated from the API contract, request signing, typed errors, and cursor-following pagination helpers.

​
Install

The package ships both ESM and CommonJS builds with bundled type declarations.
The SDK runs on Node.js 20 or newer, server-side only. Signing uses node:crypto, so it does not run in browsers or edge runtimes. Signing also needs your private key in the running process, so shipping it to an untrusted client would hand end users your signing key. The streaming client additionally needs a global WebSocket, which Node.js provides from 22 onward; on Node 20 or 21, pass one in.
The WebSocket streaming client is included in this same package at the @parlayx/sdk/stream subpath, so there’s no separate install. See the streaming Introduction.

​
Source

The SDK is published on npm. The bundled OpenAPI document is available at @parlayx/sdk/openapi/v1.json.