Polaris Public API

Developer documentation for the public Polaris exchange APIs:

Surface	Boundary	Spec
REST	ptrader-api-gateway /openapi/*	OpenAPI 3.1
WebSocket	ptrader-ws-gateway openapi quote / listenKey paths	WebSocket
FIX	ptrader-fix-server (FIXT.1.1 / FIX 5.0 SP2)	FIX

Scope

Public documentation scope is exactly the endpoints in:

postman/Polaris-OpenAPI-Order.postman_collection.json

Excluded: merchant-api/*, create-api-key tool routes, Exchange-Web / Broker-Admin / Global-Admin collections, browser /user WebSocket entry.

How to read these docs

1. Behavior authority is gateway / WS / FIX source code.
2. Postman defines the public surface and supplies request examples.
3. Items marked [NEEDS-CONFIRMATION] or listed in Gap tracker are known unknowns — do not invent values.

Quick start

1. Read Base URLs and Authentication.
2. Call GET /openapi/v1/ping then GET /openapi/v1/time.
3. Place a test order via POST /openapi/v1/order/test (signed).
4. For market streams, see Public WebSocket streams.

Use the language selector (English / 中文) in the header.

Local preview

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Build static site: mkdocs build → site/.