Skip to main content

​
Repos

Joyride currently has two source repos involved in developer documentation:
  • exchange/hybrid-clob owns the exchange, HTTP API, WebSocket API, and risk engine.
  • sdk owns the TypeScript SDK, CLI, and MCP server.
This site lives in exchange/hybrid-clob/docs and acts as the single documentation surface.

​
Base URLs

​
Local development

SurfaceDefault URL
Exchange WebSocketws://127.0.0.1:8080
Exchange HTTPhttp://127.0.0.1:8084
Risk engine WebSocketws://127.0.0.1:8082
Risk engine HTTPhttp://127.0.0.1:8086

​
Hosted environments

SurfaceURL
Exchange gatewaywss://api.joyride.exchange/gateway
Exchange HTTPhttps://api.joyride.exchange/engine
MCP HTTPhttps://api.joyride.exchange/mcp
  1. Exchange Overview
  2. Data Conventions
  3. Authentication
  4. REST API tab
  5. WebSocket Reference tab
  6. WebSocket API
  7. SDK Overview

​
Local preview

Mintlify’s CLI expects a docs.json file in the working directory. From exchange/hybrid-clob/docs: 
npx mint dev
Mintlify supports monorepo-style deployment from a subdirectory, so this repo should be configured with /docs as the documentation path in Mintlify.