Official documentation for WhiteBIT's REST and WebSocket APIs, built with Mintlify.
WhiteBIT is one of Europe's largest cryptocurrency exchanges. This repository is the source for its public developer documentation portal — the canonical reference for anyone integrating with WhiteBIT's REST and WebSocket APIs. The portal is built with Mintlify.
- REST API — v4 is the primary version (public market data, private trading, account & wallet, sub-accounts, OAuth). v1 and v2 are maintained for backward compatibility (public endpoints + legacy v1 trading).
- WebSocket API — public market streams (depth, kline, trades, last price) and private account streams (balances, orders, positions).
- OAuth — third-party account access flow and endpoint reference.
- Platform features — colocation, self-trade prevention, webhooks, WhiteBIT Codes, Convert.
- Product overviews & quickstarts — Spot, Margin, Futures, Lending, Sub-Accounts, Mining Pool, Market Data.
- Integration guides — first API call, trading bot, account monitoring, payment integration, Fireblocks, market maker, broker.
- Institutional & B2B — onboarding and compliance content.
- Resources — FAQ, glossary, SDKs, changelog.
- Individual developers building bots, scripts, and integrations against WhiteBIT.
- Institutional & B2B clients — market makers, brokers, payment integrators, Fireblocks users.
- Partners and evaluators assessing API capabilities before committing to integration work.
The OpenAPI specs under openapi/ and AsyncAPI specs under asyncapi/ are the
single source of truth for endpoint and channel definitions — the MDX pages in
api-reference/ and websocket/ provide narrative context, while the spec
itself is rendered automatically by Mintlify. An SDK is auto-generated
downstream from these OpenAPI specs, so spec accuracy is treated as a
release-blocking concern.
The portal is maintained jointly by tech writers, DevRel, and backend engineers (for spec updates). Contributor process and review checklists live in CONTRIBUTING.md. The repository also includes an AI-assisted authoring pipeline — entry points are in CLAUDE.md and ai/agent.md.
Before you begin, make sure the following tools are installed on your machine:
| Tool | Minimum Version | Installation |
|---|---|---|
| Node.js | v18+ | Download or use nvm |
| npm | v9+ (ships with Node.js) | Included with Node.js |
| Mintlify CLI | latest | npm install -g mintlify@latest |
| Redocly CLI | latest | npm install -g @redocly/cli@latest |
| AsyncAPI CLI | latest | npm install -g @asyncapi/cli |
Verify your setup:
node --version # Should print v18.x or higher
npm --version # Should print 9.x or higher
mintlify --version # Mintlify CLI
redocly --version # Redocly CLI
asyncapi --version # AsyncAPI CLIWith Prerequisites installed, start the dev server:
mintlify dev
# Open http://localhost:3000Run the docs portal in a container without installing any tools locally (requires Docker):
# Build and start
docker compose up --build
# Open http://localhost:3000The volume mount in docker-compose.yml syncs local file changes into the container in real time, so edits are reflected without restarting.
To run without live editing (static copy baked into the image):
docker build -t whitebit-docs .
docker run -p 3000:3000 whitebit-docsNote: On first start,
npx mintlify devdownloads the Mintlify client fromreleases.mintlify.com. Network access is required.
Always validate your changes before opening a PR:
# OpenAPI specs
npx @redocly/cli lint openapi/**/*.yaml
# AsyncAPI specs
find asyncapi -name "*.yaml" -exec asyncapi validate {} \;
# Local preview
mintlify devSee CONTRIBUTING.md for the full review process.
mintlify-docs/
├── openapi/ # OpenAPI specifications (REST APIs)
│ ├── public/ # Public endpoints (no auth)
│ └── private/ # Private endpoints (require auth)
├── asyncapi/ # AsyncAPI specifications (WebSocket)
│ ├── public/ # Public channels
│ └── private/ # Private channels
├── api-reference/ # REST API docs
├── websocket/ # WebSocket docs
├── platform/ # Platform feature docs (webhooks, colocation, STP, OAuth)
├── products/ # Product overviews and quickstarts
├── guides/ # Integration guides
├── institutional/ # Institutional & B2B content
├── best-practices/ # Cross-cutting best practices
├── concepts/ # Conceptual reference pages
├── data/ # Shared YAML data sources for snippets
├── snippets/ # Reusable MDX/JSX snippets
├── components/ # Custom Mintlify components
├── images/ # Image assets (plus logo/)
├── scripts/ # Build and codegen scripts
├── ai/ # AI-assisted authoring pipeline (skills, rules, style guides)
└── docs.json # Navigation configuration