These guides are for teams that connect to Polyester from their own code: market makers, trading-bot builders, and partners. They explain how the APIs behave, which rules apply, and how to recover when something goes wrong. Field-by-field schemas live in the API reference.
Testnet is the public environment for building and testing an integration; Mainnet is coming soon. Testnet uses test Assets with no monetary value. See Environments and hosts for every host.
Integration path
Place your first order
Follow the Quickstart: create an API key, get test funds, then place, read, and cancel one limit order with an official SDK or raw HTTP. For more ways to fund an account and its Subaccounts, see Testnet funds.
Point your client at the right hosts
Read Environments and hosts for the API host, the trade host, and the conventions every API shares, such as timestamps, IDs, and pagination. Regions and connectivity covers regional hosts, connection reuse, and reconnects.
Build your system
Running a quoting system? Work through the Market maker guide, a checklist that links to the page owning each decision. Prefer a worked example? Follow Build a trading bot, which builds a small two-sided quoting bot with the Python SDK.
Before you go live, read API changes and versioning to learn how contract changes are announced and published. When a request fails, start with Troubleshooting.
Interfaces
Every interface reaches the same accounts, orders, and rules; they differ in encoding and connection model. Compare them in the Connectivity matrix, and compare the official SDKs in the SDK capability matrix.
Typed calls with an official SDK or code generated from the public contracts.
- ConnectRPC getting started
- Scaled integers
- WebSocket Protobuf
- Private WebSocket for your order updates
- Protobuf trade WebSocket for order entry
- SDKs: TypeScript, Python, Go, and Rust
Readable JSON over any HTTP client.
The lowest-overhead binary order entry, with your order and execution events on the same socket.
FIX Classic and FIX-SBE are coming soon.
Guide sections
The sections below apply to every interface. Each page shows the REST and ConnectRPC names side by side where they differ.
- Trading: order types and their lifecycle, fills, sizing, client order IDs, batches, cancel-all, the dead-man switch, Swaps, rate limits, and recovery after a reconnect.
- Triggers: stop-loss, take-profit, trailing stop, TWAP, ladder, and legs attached to an order.
- Market Data: Pair rules and scales, the order book, public trades, candles, and the realtime channels.
- Account: Subaccounts and roles, API key and Subaccount policies, balances and holds, and fees and VIP tiers.
- Errors: how each interface reports an error, which errors are safe to retry, and the full error code catalog.
- Authentication & Security: request signing, API key lifecycle, replay protection, IP allowlists, session login, MFA, GuardSigner, and money-movement security.
- Funds & Transfers: deposits, internal transfers, whitelists, withdrawals from Trading, funding-flow tracking, and auto-withdraw.
Profile, analytics, rewards, changelog, and QuickSwap APIs are listed in Other APIs.
API reference
The API Docs tab in the top navigation opens the generated API reference. It lists every ConnectRPC method, REST endpoint, and realtime stream with its full request, response, and payload schema, and it is built from the same public contracts as the SDKs.
Use the reference to look up a field. Use these guides for what the reference does not show: behaviour, limits, retry rules, workflows, and examples. Guide pages link to the matching reference entry wherever they name a method.