Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jamxu88/exchange/llms.txt

Use this file to discover all available pages before exploring further.

The Exchange API exposes both a machine-readable OpenAPI schema and an interactive Swagger UI.
The live OpenAPI schema is always in sync with the running service. Fetch it directly at https://exchange.jamesxu.dev/api-doc/openapi.json to generate client code, run contract tests, or import into any OpenAPI-compatible toolchain.

​
Base URL

https://exchange.jamesxu.dev

​
OpenAPI schema and Swagger UI

ResourceURL
OpenAPI JSONhttps://exchange.jamesxu.dev/api-doc/openapi.json
Swagger UIhttps://exchange.jamesxu.dev/docs
The Swagger UI lists every endpoint with its full request and response schemas, enumerates all error codes, and lets you send live requests directly from the browser.

​
API guides

The guides below document the same surface in human-readable form, with explanations, behavioral notes, and concrete examples.

REST API

All REST endpoints: health, markets, account reads, order entry, and admin control.

WebSocket API

Socket protocol for authentication, L3 market data, trading, and user events.

Authentication

Trader x-api-key headers and admin bearer tokens.

Error codes

Structured error responses and rejection codes for REST and WebSocket.

​
Examples

For end-to-end curl, JavaScript, and Python examples covering provisioning, order management, and WebSocket sessions, see the Examples page.

Build docs developers (and LLMs) love

Get started for freeTalk to us