Skip to main content
This guide will help you get the most out of our documentation by introducing the four main sections.

​
1. Developer Guides

What you’ll find:
  • Platform overviews, concepts, and best practices
  • Step-by-step guides for common workflows
  • In-depth explanations of trading, account management, and platform features
When to use:
  • If you’re new to Rails Trading or want to understand the platform’s capabilities and workflows
  • When you need conceptual or practical guidance before diving into the API details

​
2. API Reference

What you’ll find:
  • Complete, structured reference for all REST API endpoints
  • Request/response formats, parameters, and example payloads
  • Linked to OpenAPI schemas for precise integration
When to use:
  • When building or debugging REST API integrations
  • To look up endpoint details, required fields, and response structures

​
3. WS Reference

What you’ll find:
  • Real-time streaming API documentation for WebSocket v2 and v1
  • Message formats, subscription models, and event payloads
  • Usage patterns for order books, trades, and account events
When to use:
  • For building real-time trading, monitoring, or data streaming applications
  • To understand message flows and event-driven integration

​
4. Changelog

What you’ll find:
  • A chronological log of all API and platform changes
  • Details on new features, breaking changes, and deprecations
When to use:
  • To stay up-to-date with the latest updates and plan for upcoming changes
  • For release notes and migration guidance

​
Tips for Navigating

  • Use the left navigation bar to jump between sections and pages.
  • Each section is organized by topic and use case for easy discovery.
  • Search is available for quick access to any endpoint, guide, or topic.
Ready to get started? Explore the tabs above, or return to this guide anytime from the Get Started section.