Skip to content

Introduction

Polaris exposes a Binance-style OpenAPI over the public api-gateway, plus WebSocket market/user streams and an institutional FIX acceptor.

Products covered (public)

  • Spot market data (REST + WS)
  • Spot trading & order management
  • Account / asset / wallet
  • Convert
  • Fiat & fiat migration helpers
  • Sub-account & transfer
  • Margin transfer & fund-collect
  • Payment request
  • User data stream (listenKey)

Architecture (logical)

Client
  ├─ HTTPS  → api-gateway (/openapi/*)     → order / mkdata / asset / …
  ├─ WSS    → ws-gateway  (/openapi/quote/*, /openapi/ws/<listenKey>/…)
  └─ TCP FIX→ fix-server  (FIXT.1.1 / FIX 5.0 SP2 acceptor)

Org (broker) context for REST is resolved from the HTTP Host header (BrokerInterceptor → broker apiDomain). Using the wrong host yields INVALID_PARAMETER for host.

Evidence trail

Claim Primary evidence
Public REST surface Controllers under ptrader-api-gateway/.../controller + Postman OpenAPI collection
Auth / HMAC AuthFilter, docs/API-Authentication-Mechanism.en.md in api-gateway
WS paths & streams ptrader-ws-gateway WebSocketHandler + docs/WS_API_SPOT.md
FIX session contract Postman Polaris-FIX-Document (from client guide); local fix-server checkout currently lacks src/

Draft status

Version 0.1.0-draft. Response schemas in OpenAPI are largely open objects pending DTO pass — see Gap tracker.