TypeScript SDK

Overview

The Limitless Exchange TypeScript SDK provides a type-safe client for interacting with both CLOB and NegRisk prediction markets. It handles authentication, EIP-712 order signing, market data fetching, portfolio tracking, and real-time WebSocket streaming out of the box.

Source code and issue tracker are available on GitHub.

Installation

npm
yarn
pnpm

npm install @limitless-exchange/sdk

yarn add @limitless-exchange/sdk

pnpm add @limitless-exchange/sdk

Quick Start

Configure environment variables

Create a .env file in your project root (and add it to .gitignore):

# Scoped API token (recommended) — generate at limitless.exchange → profile → Api keys
LMTS_TOKEN_ID=your_token_id
LMTS_TOKEN_SECRET=your_base64_secret
PRIVATE_KEY=0xYourPrivateKeyHere
# Legacy API key (still works; not recommended for new integrations)
LIMITLESS_API_KEY=lmts_your_api_key_here

Pass LMTS_TOKEN_ID / LMTS_TOKEN_SECRET to the client as hmacCredentials. The legacy LIMITLESS_API_KEY is auto-loaded if no credentials are passed, but a scoped API token is preferred.

Initialize the HTTP client

import { HttpClient } from '@limitless-exchange/sdk';

const httpClient = new HttpClient({
  baseURL: 'https://api.limitless.exchange',
});

Fetch active markets

import { MarketFetcher } from '@limitless-exchange/sdk';

const marketFetcher = new MarketFetcher(httpClient);

const { data: markets } = await marketFetcher.getActiveMarkets({
  limit: 10,
  sortBy: 'newest',
});

for (const market of markets) {
  console.log(market.slug, market.title);
}

Authenticate for trading

For operations that require authentication (placing orders, fetching portfolio), supply your scoped API token credentials and wallet:

import { ethers } from 'ethers';

const httpClient = new HttpClient({
  baseURL: 'https://api.limitless.exchange',
  hmacCredentials: {
    tokenId: process.env.LMTS_TOKEN_ID,
    secret: process.env.LMTS_TOKEN_SECRET,
  },
});

const wallet = new ethers.Wallet(process.env.PRIVATE_KEY!);

Environment Variables

Variable	Required	Description
`LMTS_TOKEN_ID`	Recommended	Scoped token ID used for HMAC request signing. Generate at limitless.exchange → profile → Api keys.
`LMTS_TOKEN_SECRET`	Recommended	Base64 token secret used for HMAC request signing. Shown once at creation.
`PRIVATE_KEY`	For order signing	Ethereum private key used for EIP-712 order signatures. Never commit to version control.
`LIMITLESS_API_KEY`	Legacy (optional)	Legacy `X-API-Key` value, auto-loaded by the SDK. Still works; prefer a scoped API token.

Client constructor

The recommended entrypoint is the root Client class, which composes all domain services (markets, portfolio, orders, API tokens, partner accounts, delegated orders):

import { Client } from '@limitless-exchange/sdk';

const client = new Client({
  baseURL: 'https://api.limitless.exchange',
  hmacCredentials: {
    tokenId: process.env.LMTS_TOKEN_ID!,
    secret: process.env.LMTS_TOKEN_SECRET!,
  },
});

With hmacCredentials set, the SDK automatically generates and sends lmts-api-key, lmts-timestamp, and lmts-signature on each request. Do not manually build HMAC headers when using the SDK client.

Legacy: an older API key (LIMITLESS_API_KEY, sent as the X-API-Key header) still works but is not recommended for new integrations. To use it, pass apiKey: 'lmts_...' or set the LIMITLESS_API_KEY env var instead of hmacCredentials. Prefer a scoped API token.

Option	Type	Default	Description
`baseURL`	`string`	—	API base URL
`apiKey`	`string`	`process.env.LIMITLESS_API_KEY`	Legacy `X-API-Key` auth (still works; prefer a scoped API token)
`hmacCredentials`	`{ tokenId, secret }`	—	HMAC credentials for scoped API token auth (see Programmatic API)
`timeout`	`number`	`30000`	Request timeout in milliseconds
`additionalHeaders`	`Record<string, string>`	`{}`	Additional headers sent with every request

HttpClient (lower-level)

You can also use HttpClient directly for more control:

import { HttpClient } from '@limitless-exchange/sdk';

const httpClient = new HttpClient({
  baseURL: 'https://api.limitless.exchange',
  hmacCredentials: {
    tokenId: process.env.LMTS_TOKEN_ID,
    secret: process.env.LMTS_TOKEN_SECRET,
  },
});

What You Can Build

Markets

Discover markets, fetch orderbooks, and query NegRisk groups.

Market Pages

Browse markets by category with navigation, filters, and pagination.

Trading and Orders

Create GTC and FOK orders, manage approvals, and cancel orders.

Portfolio and Positions

Track CLOB and AMM positions, PnL, and trade history.

API Tokens

Derive, list, and revoke scoped HMAC tokens for partner integrations.

Partner Accounts

Create sub-accounts with server wallets or EOA verification.

Delegated Orders

Place orders on behalf of sub-accounts with server-side signing.

WebSocket Streaming

Real-time orderbook, price, position, and transaction events.

Server Wallet Redemption and Withdrawal

For partner server-wallet sub-accounts, the SDK provides helper methods for payout settlement and treasury movement:

POST /portfolio/redeem — claim resolved positions
POST /portfolio/withdraw — transfer ERC20 funds from managed sub-accounts
POST /portfolio/withdrawal-addresses — allowlist an explicit treasury destination with Privy identity auth
DELETE /portfolio/withdrawal-addresses/:address — remove an allowlisted destination with Privy identity auth

Required scopes for apiToken auth: trading for redeem and withdrawal for withdraw. Allowlist add/delete calls use a Privy identity token instead of API-token/HMAC auth.

const identityToken = process.env.PRIVY_IDENTITY_TOKEN!;
const treasuryAddress = '0x0F3262730c909408042F9Da345a916dc0e1F9787';

await client.partnerAccounts.addWithdrawalAddress(identityToken, {
  address: treasuryAddress,
  label: 'treasury',
});

await client.serverWallets.withdraw({
  amount: '1000000',
  onBehalfOf: childProfileId,
  destination: treasuryAddress,
});

Set onBehalfOf when withdrawing from a child server-wallet profile. destination is optional for child withdrawals; when omitted, the API defaults to the authenticated partner smart wallet when present, otherwise the authenticated partner account. You can omit onBehalfOf only when withdrawing the authenticated caller’s own server wallet to an explicit destination. See the full flow and scope guidance in Programmatic API.

Disclaimer

USE AT YOUR OWN RISK. This SDK and the Limitless Exchange protocol are provided as-is with no warranties. You are solely responsible for any funds used or lost. By using this SDK, you acknowledge that prediction markets involve financial risk. The Limitless Exchange is not available to users in the United States or other restricted jurisdictions. Ensure compliance with your local laws before trading.

Getting Started

Quick Start

Python SDK

Go SDK

Rust SDK

WebSocket

TypeScript SDK

Overview

Installation

Quick Start

Environment Variables

Client constructor

HttpClient (lower-level)

What You Can Build

Markets

Market Pages

Trading and Orders

Portfolio and Positions

API Tokens

Partner Accounts

Delegated Orders

WebSocket Streaming

Server Wallet Redemption and Withdrawal

Disclaimer

​Overview

​Installation

​Quick Start

​Environment Variables

​Client constructor

​HttpClient (lower-level)

​What You Can Build

Markets

Market Pages

Trading and Orders

Portfolio and Positions

API Tokens

Partner Accounts

Delegated Orders

WebSocket Streaming

​Server Wallet Redemption and Withdrawal

​Disclaimer

Overview

Installation

Quick Start

Environment Variables

Client constructor

HttpClient (lower-level)

What You Can Build

Server Wallet Redemption and Withdrawal

Disclaimer