WhiteBIT API Documentation

Official documentation for WhiteBIT's REST and WebSocket APIs, built with Mintlify.

Quick Start

Get the documentation running locally in 2 minutes:

# Install Mintlify CLI
npm install -g mintlify@latest

# Start dev server
mint dev

# Open http://localhost:3000

Full setup instructions → Validation Guide

Documentation Tasks

Contributing to the API docs? Choose your task:

Common Tasks

• Adding Parameters - Add query, body, or WebSocket parameters
• Adding Descriptions - Write endpoint overviews and descriptions
• Parameter Exceptions - Document optional, conditional, or exclusive parameters
• Documenting Errors - Add error codes and error responses
• Adding New Endpoints - Complete workflow for new REST or WebSocket endpoints

Contributing

See CONTRIBUTING.md for:

• Git workflow and branching strategy
• Commit message format
• Pull request process
• Review checklists for tech writers, DevRel engineers, and developers

Reference Documentation

Quick Access

• File Structure Decision Tree - Which file should I edit?
• Style Guide - Writing standards and best practices
• Quick Reference - Tables, patterns, error codes
• Common Pitfalls - Avoid frequent mistakes
• Validation Guide - Local dev environment and testing

External Resources

• OpenAPI 3.0.3 Specification
• AsyncAPI 3.0.0 Specification
• Mintlify Documentation

Project Structure

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
├── public/            # MDX docs for public APIs
├── private/           # MDX docs for private APIs
├── docs/              # Internal documentation
│   ├── guides/        # Step-by-step task guides
│   └── reference/     # Reference materials
└── docs.json          # Navigation configuration

Getting Help

For technical questions:

• Check existing similar endpoints in the codebase
• See Validation Guide
• Search OpenAPI/AsyncAPI specifications

For style questions:

• Consult Style Guide
• Ask tech writer team lead
• Check glossary for terminology

For API accuracy questions:

• Ask backend engineering team
• Check staging environment responses
• Review internal API specifications

For process questions:

• Review CONTRIBUTING.md
• Ask DevRel team lead
• Check PR review checklists

Validation Before Submitting

Always validate your changes before creating a PR:

# OpenAPI validation
npx @redocly/cli lint openapi/**/*.yaml

# AsyncAPI validation
find asyncapi -name "*.yaml" -exec asyncapi validate {} \;

# Test in dev server
mint dev

See Validation Guide for detailed instructions.

---

Last Updated: 2026-01-30
Maintainers: Technical Writing Team, DevRel Team
Questions?: Contact team leads or post in #documentation-help