TESTNET
Connect

Trading services

Services on this page use the authenticated transport except client.tradingRateLimits.getConfig(), which reads the public policy. Every account-scoped input accepts an optional account field ("main", "active", or { subaccountId }). See Accounts & balances. Methods marked stream return () => void and take onEvent (plus optional onOpen / onClose / onError).

client.orders

Method Input → Result Notes
create(input, options?) NewOrderInput → CreateOrderResult Validates shape and decimal scale locally; catalog constraint checks are opt-in.
batchCreate(input, options?) { requestId?, items } → ordered per-item results Max 20 items; the SDK generates requestId when omitted. Per-item client ids are optional.
modify(input, options?) ModifyOrderInput → ModifyOrderResult Price/qty/client-id/risk patch; AMENDED keeps the id, REPLACED issues finalOrderId.
preview(input, options?) NewOrderInput → PreviewOrderResult Evaluates an intent; places nothing.
batchReplace(input, options?) { symbolId, requestId?, items } → admission receipt Max 50 unique targets; one symbol per batch.
getBatchReplaceStatus(input, options?) { batchRequestId } → durable per-item status Reads the receipt returned by batchReplace.
cancel(input, options?) { orderId } or { clientOrderId }, symbolId? → CancelOrderResult Status is accepted or unspecified; reconcile final state.
batchCancel(input, options?) { requestId?, items } → per-item results Max 50 explicit order keys; item status is accepted, rejected, or unspecified.
cancelAll(input, options?) symbolIds? (max 100), side?, dryRun?, requestId? → CancelAllOrdersResponse Empty symbolIds matches all; status is submitted, dry_run, or unspecified.
cancelAllAfter(input, options?) timeoutSec, symbolId?, side?, requestId? → heartbeat result Status is armed, disabled, or unspecified.
listOpen(input?, options?) symbolId?: number[], triggerId?, side?, pagination, risk-inclusion filters → { orders, nextPageToken } Drain every page via nextPageToken.
listHistory(input?, options?) + status?, triggerId?, nanosecond time range → { orders, nextPageToken }
getDetails(input, options?) order key, execution-history pagination → OrderDetails | null One lineage-execution page; deduplicate transfers by txId.
subscribe(input) accountId → stream of Order

NewOrderInput

Field Type Required Notes
symbolId number ✓ Stable positive market ID.
side "buy" | "sell" ✓
qty decimal string ✓ Base-asset quantity; strict precision.
execution OrderExecutionInput ✓ Exact order execution.
clientOrderId string Account-scoped duplicate guard.
feeAsset "quote" | "base" Defaults to "quote".
selfTradePreventionMode "expire_taker" | "expire_maker" | "expire_both"
risk RiskPolicyInput Attached TP/SL/trailing legs (below).
account AccountScope Scope override.

OrderExecutionInput is one of market_ioc (optional maxSlippage and clientRefPrice), limit_gtc (price, optional postOnly), limit_gtd (price, integer epoch-millisecond expireAt, optional postOnly), limit_ioc (price), or limit_fok (price). GTD reads expose timeInForce: "GTD" and expireAt when supplied by the venue. CreateOrderResult acknowledges admission with the order/client ids, acceptedAt, acceptedAtNs, and any attached-risk trigger ids. It does not report order lifecycle status.

RiskPolicyInput

Valid combinations: takeProfit + stopLoss, takeProfit + trailingStop, or any single leg. oco: true requires takeProfit plus exactly one stop leg; on a single leg it is rejected.

  • takeProfit / stopLoss: { triggerPrice, execution }, with market_ioc or limit_gtc execution.
  • trailingStop: { trailingDistance, maxSlippage?, activationPrice? } (market IOC).
  • Distances/slippage take { kind: "distance", distance: "500" }, { kind: "slippage", slippage: "0.25" }, or { kind: "bps", bps: 50 } (at most 10,000). { kind: "none" } is valid for maxSlippage only.

ModifyOrderInput

Key: { orderId } or { clientOrderId }. Base: symbolId (required), requestId?, newClientOrderId?, behavior?. Patch: newPrice? and/or newQty?; risk: risk (replace) or clearRisk: true. Those two risk options are mutually exclusive.

client.triggers

Standalone automations that place a child order when a condition fires. Types: stop_loss, take_profit, trailing_stop, twap, ladder.

Method Input → Result Notes
create(input, options?) CreateTriggerInput (variant on triggerType) → CreateTriggerResult clientTriggerId auto-generated when omitted.
get(input, options?) triggerId → Trigger | null
list(input?, options?) symbolId?, status/type/parent-order filters, pagination → ListTriggersResult Newest first.
modify(input, options?) triggerId, symbolId + ≥ 1 patch field → ModifyTriggerResult Omit activation/slippage to preserve it; { kind: "none" } clears either.
cancel(input, options?) triggerId → CancelTriggerResult
pause(input, options?) triggerId → PauseTriggerResult
resume(input, options?) triggerId, symbolId → ResumeTriggerResult
listEvents(input, options?) triggerId, limit? (default 50) → ListTriggerEventsResult Fire/cancel/update/failure events, newest first.
subscribe(input) accountId → stream of Trigger state
subscribeEvents(input) accountId → stream of lifecycle events

CreateTriggerInput

All variants share symbolId, qty, feeAsset?, selfTradePreventionMode?, clientTriggerId?, and account?. Strategy-specific fields describe the exact child execution.

Per-type fields:

triggerType Fields
"stop_loss" / "take_profit" side, triggerPrice, execution (sell: market_ioc or limit; buy: limit only)
"trailing_stop" trailingDistance, activationPrice?, maxSlippage?; always sells using market IOC
"twap" side, durationMs, sliceIntervalMs, execution (market_ioc with maxSlippage?, or limit_gtc)
"ladder" side, priceMin, priceMax, levels (2-100), postOnly?; children are linear limit GTC

CreateTriggerResult acknowledges admission with triggerId, clientTriggerId, acceptedAt, and acceptedAtNs; it does not report runtime status. Read models expose immutable configuration plus separate runtimeDetails. Terminal triggers and events expose typed, mutually exclusive cancelReason or failureReason fields.

client.trades

Your fills.

Method Input → Result Notes
list(input?, options?) symbol/side/time/pagination, orderId? or lineageId?, transfers → { trades, transfers, nextPageToken } afterMatchId requires a positive symbolId string.
subscribe(input) accountId → stream of trades

All prices/quantities in results are decimal strings; orders on symbols missing from the catalog are filtered out of list responses rather than failing the whole page. Scope executions to one physical orderId or logical lineageId, optionally through a generation. includeTransfers returns settlement transfers for page matches; deduplicate them across pages by txId.

client.fees

Authenticated spot-fee service. getSpotRates returns the effective maker and taker percents for the resolved account. Full shapes: Fees.

Method Input → Result Notes
getSpotRates(input?, options?) symbolIds? (max 100), account? → SpotFeeRate[] Empty symbolIds returns every market.

client.tradingRateLimits

Trading-quota service. getConfig is the public VIP0+ catalog. getTradingLimits is the effective placement and cancellation rules for the resolved account, plus any API-key overlay. Full shapes: Trading rate limits.

Method Input → Result Notes
getConfig(options?) → RateLimitConfig Public.
getTradingLimits(input?, options?) account? → TradingRateLimits Authenticated.
Accounts Resolve usernames, account IDs, and smart-account addresses into transfer destinations. Address book Manage saved transfer destinations, tags, whitelists, and recent counterparties per account book. API keys Generate Ed25519 keypairs, create and manage API keys, and attach reusable permission policies. Auth Introspect the caller, request SIWE wallet challenges, and run the managed browser login, session, and account-switching flow. Balances Read current ledger balances, plus balance and equity history, and stream live balance updates. Candles Read and stream public spot OHLCV candles in row and columnar formats. Catalog The reference-data store behind every symbol lookup and decimal conversion, with typed readers for markets, ledger assets, order constraints, and zipper routes. Chain analytics Public chain chart series (zToken supply and unified balances) as columnar time windows. Client configuration Constructors, config options, auth providers, request options, and package entry points. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors The complete error hierarchy: classes, codes, retryability, and helper functions. Fees Look up the effective spot maker and taker rates that apply to fills for a given account. Guard signer Manage backend guard wallets that co-sign protected account actions like whitelist changes. Heatmap Order book liquidity heatmaps as delta chains, plus a live per-interval bucket stream. Internal transfers Move funds between Polyester accounts instantly, without touching a chain. Lifecycle Read and stream cross-chain flow state for deposits and withdrawals, with history, per-flow detail, and live progress. Market overview Ticker-style per-market stats with last and index prices, 24h stats, top-of-book, and optional sparklines. MFA Enroll TOTP and passkey factors, run challenges, manage recovery codes, and mint step-up proofs. Order book Depth snapshots and a stateful live order book that reconstructs the book for you. Orders Place, modify, cancel, and read spot orders, with attached take-profit, stop-loss, and trailing-stop risk. Profile Read and update the caller's public profile, review username history, and stream public identity updates. Public trades Read and stream public spot trade prints, plus the raw spot config that feeds the catalog. Trading rate limits Fetch the public trading quota catalog, or the placement and cancellation limits that apply to an account. Realtime client The shared realtime connection every subscribe method rides, plus its handler contract, refcounting, and public versus private channels. Social verification Prove ownership of a Twitter account or Discord identity with provider-specific verification. Subaccounts Create, share, audit, and stream subaccounts, and manage the reusable policy templates that govern them. Trades List and stream your fills, with prices, quantities, fees, and liquidity as parsed decimal strings. Transfers Read and stream the ledger transfer history behind every balance movement on your account. Triggers Create, manage, and stream standalone automations that place a child order when a market condition fires. VIP Fetch the public VIP tier catalog, or the authenticated root account's current qualification. Withdrawals Create durable, signed withdrawal intents out of the Trading venue, to Funding or to an external chain. Zipper Read the deposit and withdraw configuration (chains, unified assets, routes, fees, minimums, contracts) and stream live route supply. Market data services Reference for the public services: market data, overview, candles, order book, heatmap, chain analytics, zipper, and lifecycle. Account services Reference for auth, subaccounts, API keys, balances, MFA, address book, profile, VIP, and related account services. Funding services Reference for deposits, ledger transfers, internal transfers, and trading withdrawals.
Previous

Market data services
Next

Account services