Polymarket TypeScript SDK

This repository is the home for Polymarket's official TypeScript SDK packages.

Repository Structure

This repository is organized as a pnpm workspace with SDK packages and examples.

Package	Description
packages/client	Official TypeScript client for building on Polymarket
packages/types	Shared TypeScript types for SDK packages
packages/bindings	Internal generated API bindings; not intended for direct usage
examples/scripts	Runnable TypeScript scripts for common SDK workflows

For installation and usage, see packages/client.

API Compatibility

The SDK follows semantic versioning. Although minor releases on the 0.x line may include breaking changes, we aim to avoid them and, whenever possible, provide a deprecation path before removing or changing an API. Patch releases remain backward compatible except for APIs marked @experimental, which may change in any release. The Perps APIs are currently experimental.

Local Development

Requirements

• Node.js >=24
• pnpm >=10

Install dependencies:

nvm use
corepack install
pnpm install

Set up local environment variables:

cp .env.example .env

Then open .env and fill in the fields.

Build all workspace packages:

pnpm build

Development Scripts

The root scripts are:

• pnpm build - build all workspace packages that expose a build script
• pnpm clean - remove package build output from packages/*/dist

TypeScript Config

• Root tsconfig.json and package-level tsconfig.json files are for editor tooling and source navigation.
• tsconfig.build.json files are the configs used by package build and typecheck commands.
• When changing build behavior, prefer updating tsconfig.build.json.

Contributing

We welcome bug reports, feature requests, and feedback through GitHub Issues. See CONTRIBUTING.md before proposing code changes.

Maintainer Notes

Publishing

Publishing is managed by the Changesets GitHub Action. Packages are published to npm through trusted publishing.

License

This project is licensed under the MIT License.