Installation - ParlayX

There are two official clients for the ParlayX API, one for Python and one for TypeScript. Both cover the same surface, generated from the same API contract, and both handle request signing, typed errors, and cursor-following pagination.

Install

pip install parlayx

npm install @parlayx/sdk

With uv, uv add parlayx.

Both clients are server-side only. Signing needs your private key in the running process, so shipping either to an untrusted client would hand end users your signing key. The TypeScript client signs with node:crypto, so it does not run in browsers or edge runtimes.

What each package gives you

	Python	TypeScript
Package	`parlayx`	`@parlayx/sdk`
Runtime	Python 3.11 or newer	Node.js 20 or newer
Distribution	one pure Python wheel, no build step	ESM and CommonJS builds
Types	a `py.typed` marker, no stubs to install	bundled declarations
Streaming	the `parlayx.stream` module	the `@parlayx/sdk/stream` subpath
Async	`AsyncParlayX` alongside `ParlayX`	promises throughout

The streaming client is in the same package as the REST client in both languages, so there is nothing extra to install. There is no parlayx[stream] extra.

from parlayx.stream import StreamClient

import { createStreamClient } from "@parlayx/sdk/stream";

See the streaming Introduction.

Language notes

Python
TypeScript

ParlayX and AsyncParlayX expose the same methods over one transport, so the two differ by await and nothing else. The stream client is async only, because it is an async iterator.

from parlayx import AsyncParlayX, ParlayX

client = ParlayX()

async with AsyncParlayX() as async_client:
    who = await async_client.whoami()

Both clients hold a connection pool, so create one and reuse it rather than building one per call. Closing is handled by with or async with; call close() yourself if you keep one for the life of the process.Fields accept either spelling, time_in_force or timeInForce. The wire always carries the API’s own camelCase.Four runtime dependencies, declared as ranges rather than pins so they resolve alongside the rest of your environment: httpx, pydantic, cryptography and websockets.

The package ships both ESM and CommonJS builds with bundled type declarations.The streaming client additionally needs a global WebSocket, which Node.js provides from 22 onward. On Node 20 or 21, pass one in. See Client options.

Source

@parlayx/sdk is published on npm and parlayx on PyPI, both MIT licensed. The bundled OpenAPI document is available at @parlayx/sdk/openapi/v1.json.

​Install

​What each package gives you

​Language notes

​Source

Install

What each package gives you

Language notes

Source