@predexon/sdk
v0.1.2
Published
Unified, type-safe TypeScript SDK for the Predexon prediction-market APIs — market data and trading in one client.
Maintainers
Readme
@predexon/sdk
Unified, type-safe TypeScript SDK for the Predexon prediction-market APIs — market data and trading in one client.
Summary
Predexon API: Unified, type-safe TypeScript SDK for the Predexon prediction-market APIs — market data and trading in one client.
Coverage
- Data API (
api.predexon.com): markets, prices, candlesticks, orderbook history, trades, wallet analytics, smart-money & leaderboards across Polymarket, Kalshi, Limitless, Opinion, Predict.Fun, Dflow, and Binance, plus cross-venue search. - Trading API (
trade.predexon.com): managed accounts, order placement & management, balances, positions, fund transfers/bridging, and cross-venue order routing.
Two API keys The data and trading planes are authenticated separately. Provide both via the SDK config or environment variables — the SDK automatically routes each call to the correct host:
const predexon = new Predexon({
security: {
dataApiKey: process.env.PREDEXON_DATA_API_KEY, // → api.predexon.com
tradingApiKey: process.env.PREDEXON_TRADING_API_KEY, // → trade.predexon.com
},
});Errors are unified across both planes — every error exposes .error, .message, and .statusCode.
Funding note: inbound deposits from non-Base chains return a transaction for the end user to sign; Hyperliquid uses a separate funding path. See the funding guide.
Full docs: https://docs.predexon.com
Table of Contents
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @predexon/sdkPNPM
pnpm add @predexon/sdkBun
bun add @predexon/sdkYarn
yarn add @predexon/sdk[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use
await import()to import and use this package.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { Predexon } from "@predexon/sdk";
const predexon = new Predexon({
security: {
dataApiKey: process.env["PREDEXON_DATA_API_KEY"] ?? "",
},
});
async function run() {
const result = await predexon.search.markets({
q: "trump",
venue: "polymarket,kalshi",
});
console.log(result);
}
run();
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme | Environment Variable |
| --------------- | ------ | ------- | -------------------------- |
| dataApiKey | apiKey | API key | PREDEXON_DATA_API_KEY |
| tradingApiKey | apiKey | API key | PREDEXON_TRADING_API_KEY |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { Predexon } from "@predexon/sdk";
const predexon = new Predexon({
security: {
dataApiKey: process.env["PREDEXON_DATA_API_KEY"] ?? "",
},
});
async function run() {
const result = await predexon.search.markets({
q: "trump",
venue: "polymarket,kalshi",
});
console.log(result);
}
run();
Import paths
Everything you need is reachable from one of these four subpaths.
| Subpath | Holds |
|---------|-------|
| @predexon/sdk | The Predexon client, HTTPClient, transport types |
| @predexon/sdk/models/errors | All error classes (PredexonError, ApiError, DataErrorResponse, etc.), the TradingErrorCode enum, and the Detail type |
| @predexon/sdk/models | Every schema type — markets, accounts, balances, sort/filter enums, response shapes |
| @predexon/sdk/models/operations | Per-operation Request types (and Response types when an operation returns more than just the body) |
import { Predexon } from "@predexon/sdk";
import { ApiError, TradingErrorCode } from "@predexon/sdk/models/errors";
import { Account, PolymarketMarket, KalshiMarketsSortOption } from "@predexon/sdk/models";
import type { PlaceOrderAccountRequest } from "@predexon/sdk/models/operations";Available Resources and Operations
Accounts
- create - Create Account
- list - List Accounts
- get - Get Account
- delete - Delete Account
- enableVenue - Enable Venue
- getBalance - Get Balance
- listPositions - Get Positions
- redeem - Redeem Position
Binance
- getTicks - Get Binance Ticks
- getCandlesticks - Get Binance Candles
Dflow
- getTrades - Get Dflow Trades
- getWalletPnL - Get Dflow Wallet Pnl
- getWalletPositions - Get Dflow Wallet Positions
Kalshi
- listMarkets - Get Kalshi Markets
- getTrades - Get Kalshi Trades
- getOrderbookHistory - Get Kalshi Orderbooks
Limitless
- listMarkets - Get Limitless Markets
- getOrderbookHistory - Get Limitless Orderbooks
Opinion
- listMarkets - Get Opinion Markets
- getOrderbookHistory - Get Opinion Orderbooks
Orders
- place - Place Order
- list - Get Orders
- cancelAll - Cancel All Orders
- get - Get Order
- cancel - Cancel Order
Polymarket
- getWalletPnL - Get Wallet Pnl
- getWalletPositions - Get Wallet Positions
- getWalletVolumeChart - Get Wallet Volume Chart
- getWalletIdentity - Get Wallet Identity
- getWalletIdentities - Get Wallet Identities
- getCandlesticks - Get Candlesticks
- getTokenPrice - Get Market Price
- getActivity - Get Activity
- listMarkets - Get Markets
- listMarketsKeyset - List Markets (Keyset Pagination)
- getVolumeTimeSeries - Get Market Volume Time Series
- getOpenInterestTimeSeries - Get Market Open Interest Time Series
- getOrderbookHistory - Get Orderbooks
- getTrades - Get Trades
- getVolumeChart - Get Volume Chart
- getWalletProfile - Get Wallet Profile
- getWalletProfiles - Get Wallet Profiles Batch
- getLeaderboard - Get Leaderboard
- getMarketLeaderboard - Get Market Leaderboard
- getMarketTopHolders - Get Market Top Holders
- getWalletMarkets - Get Wallet Markets
- filterWalletsByMarkets - Filter Wallets By Markets
- listSmartActivityMarkets - Get Smart Activity Markets
- getSmartMoneyPositioning - Get Smart Money Positioning
- getSimilarWallets - Get Similar Wallets
- getCohortStats - Get Cohort Stats
- listCryptoMarkets - Get Crypto Updown
- listEvents - Get Events
- listEventsKeyset - Get Events Keyset
- listAllPositions - Get All Positions
- getUmaMarket - Get Uma Market
- listUmaMarkets - List Uma Markets
- getCandlesticksByToken - Get Candlesticks By Token
- getConnectedWallets - Connected wallets for an address (graph-based)
- getBuilderLeaderboard - Get Builder Leaderboard
- getBuilderStats - Get Builder Stats
- getBuilderMarkets - Get Builder Markets
- getBuilderTimeSeries - Get Builder Timeseries
Predictfun
- listMarkets - Get Predict Markets
- getOrderbookHistory - Get Predictfun Orderbooks
Router
- quote - Get Router Quote
- placeOrder - Place Router Order
- listOrders - List Router Orders
- getOrder - Get Router Order
- cancelOrder - Cancel Router Order
Search
- markets - Search Markets Across Venues
Transfers
- getDepositWallet - Get Deposit Info
- withdrawDirect - Withdraw Funds
- create - Create Transfer
- list - List Transfers
- get - Get Transfer
- quote - Quote Transfer
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
accountsCreate- Create AccountaccountsDelete- Delete AccountaccountsEnableVenue- Enable VenueaccountsGet- Get AccountaccountsGetBalance- Get BalanceaccountsList- List AccountsaccountsListPositions- Get PositionsaccountsRedeem- Redeem PositionbinanceGetCandlesticks- Get Binance CandlesbinanceGetTicks- Get Binance TicksdflowGetTrades- Get Dflow TradesdflowGetWalletPnL- Get Dflow Wallet PnldflowGetWalletPositions- Get Dflow Wallet PositionskalshiGetOrderbookHistory- Get Kalshi OrderbookskalshiGetTrades- Get Kalshi TradeskalshiListMarkets- Get Kalshi MarketslimitlessGetOrderbookHistory- Get Limitless OrderbookslimitlessListMarkets- Get Limitless MarketsopinionGetOrderbookHistory- Get Opinion OrderbooksopinionListMarkets- Get Opinion MarketsordersCancel- Cancel OrderordersCancelAll- Cancel All OrdersordersGet- Get OrderordersList- Get OrdersordersPlace- Place OrderpolymarketFilterWalletsByMarkets- Filter Wallets By MarketspolymarketGetActivity- Get ActivitypolymarketGetBuilderLeaderboard- Get Builder LeaderboardpolymarketGetBuilderMarkets- Get Builder MarketspolymarketGetBuilderStats- Get Builder StatspolymarketGetBuilderTimeSeries- Get Builder TimeseriespolymarketGetCandlesticks- Get CandlestickspolymarketGetCandlesticksByToken- Get Candlesticks By TokenpolymarketGetCohortStats- Get Cohort StatspolymarketGetConnectedWallets- Connected wallets for an address (graph-based)polymarketGetLeaderboard- Get LeaderboardpolymarketGetMarketLeaderboard- Get Market LeaderboardpolymarketGetMarketTopHolders- Get Market Top HolderspolymarketGetOpenInterestTimeSeries- Get Market Open Interest Time SeriespolymarketGetOrderbookHistory- Get OrderbookspolymarketGetSimilarWallets- Get Similar WalletspolymarketGetSmartMoneyPositioning- Get Smart Money PositioningpolymarketGetTokenPrice- Get Market PricepolymarketGetTrades- Get TradespolymarketGetUmaMarket- Get Uma MarketpolymarketGetVolumeChart- Get Volume ChartpolymarketGetVolumeTimeSeries- Get Market Volume Time SeriespolymarketGetWalletIdentities- Get Wallet IdentitiespolymarketGetWalletIdentity- Get Wallet IdentitypolymarketGetWalletMarkets- Get Wallet MarketspolymarketGetWalletPnL- Get Wallet PnlpolymarketGetWalletPositions- Get Wallet PositionspolymarketGetWalletProfile- Get Wallet ProfilepolymarketGetWalletProfiles- Get Wallet Profiles BatchpolymarketGetWalletVolumeChart- Get Wallet Volume ChartpolymarketListAllPositions- Get All PositionspolymarketListCryptoMarkets- Get Crypto UpdownpolymarketListEvents- Get EventspolymarketListEventsKeyset- Get Events KeysetpolymarketListMarkets- Get MarketspolymarketListMarketsKeyset- List Markets (Keyset Pagination)polymarketListSmartActivityMarkets- Get Smart Activity MarketspolymarketListUmaMarkets- List Uma MarketspredictfunGetOrderbookHistory- Get Predictfun OrderbookspredictfunListMarkets- Get Predict MarketsrouterCancelOrder- Cancel Router OrderrouterGetOrder- Get Router OrderrouterListOrders- List Router OrdersrouterPlaceOrder- Place Router OrderrouterQuote- Get Router QuotesearchMarkets- Search Markets Across VenuestransfersCreate- Create TransfertransfersGet- Get TransfertransfersGetDepositWallet- Get Deposit InfotransfersList- List TransferstransfersQuote- Quote TransfertransfersWithdrawDirect- Withdraw Funds
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Predexon } from "@predexon/sdk";
const predexon = new Predexon({
security: {
dataApiKey: process.env["PREDEXON_DATA_API_KEY"] ?? "",
},
});
async function run() {
const result = await predexon.search.markets({
q: "trump",
venue: "polymarket,kalshi",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Predexon } from "@predexon/sdk";
const predexon = new Predexon({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
dataApiKey: process.env["PREDEXON_DATA_API_KEY"] ?? "",
},
});
async function run() {
const result = await predexon.search.markets({
q: "trump",
venue: "polymarket,kalshi",
});
console.log(result);
}
run();
Error Handling
PredexonError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
Example
import { Predexon } from "@predexon/sdk";
import * as errors from "@predexon/sdk/models/errors";
const predexon = new Predexon({
security: {
dataApiKey: process.env["PREDEXON_DATA_API_KEY"] ?? "",
},
});
async function run() {
try {
const result = await predexon.search.markets({
q: "trump",
venue: "polymarket,kalshi",
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.PredexonError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.DataErrorResponse) {
console.log(error.data$.detail); // models.Detail
}
}
}
}
run();
Error Classes
Primary error:
PredexonError: The base class for HTTP error responses.
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from PredexonError:
HTTPValidationError: Status code422. Applicable to 53 of 77 methods.*DataErrorResponse: Applicable to 44 of 77 methods.*ApiError: Unified error envelope returned by every endpoint on any 4xx or 5xx response. Theerrorfield is a stable snake_case code partners can branch on;messageis the human-readable explanation (free-form, may change);requestIdis the request correlation id (also returned in thex-request-idresponse header) — quote it when contacting support. Applicable to 24 of 77 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to:
- route requests through a proxy server using undici's ProxyAgent
- use the
"beforeRequest"hook to add a custom header and a timeout to requests - use the
"requestError"hook to log errors
import { Predexon } from "@predexon/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@predexon/sdk/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Predexon({ httpClient: httpClient });Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Sensitive headers (e.g.
x-api-key,authorization) are redacted in debug logs. Request and response bodies are logged in full, so enable debug logging only during local development, not in production.
import { Predexon } from "@predexon/sdk";
const sdk = new Predexon({ debugLogger: console });You can also enable a default debug logger by setting an environment variable PREDEXON_DEBUG to true.
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
