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

​
Choosing your product

Use the tabs at the top of the page to move between:
  • Home — a landing page with quick links into every part of the docs.
  • Get Started — shared setup that applies to both products: account setup, environments, API keys and authorization, and deposits/withdrawals.
  • Perpetuals — everything specific to perpetuals trading.
  • Options — everything specific to options trading.
Not sure which product you need? See Perpetuals vs Options. Within each product you’ll find the same four sections, described below.

​
1. Guides

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

​
2. Formulas

What you’ll find:
  • The exact math behind the platform — pricing, Greeks, margin, fees, funding, and position metrics
  • Definitions of every input and how values are derived
When to use:
  • When you need to reproduce prices, margin, or PnL exactly
  • To understand the calculations referenced from the Guides

​
3. WS Reference

What you’ll find:
  • Real-time streaming API documentation for our WebSocket API
  • Message formats, subscription models, and event payloads
  • Usage patterns for order books, trades, positions, 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. 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

​
Changelog & Error Reference

What you’ll find:
  • Changelog — a chronological log of all API and platform changes, including new features, breaking changes, and deprecations.
  • Error Reference — error codes and slugs returned across the APIs.
When to use:
  • To stay up-to-date with the latest updates and plan for upcoming changes.
  • To look up the meaning of an error returned by a request.
Both live under Get Started → Resources and apply across both products.

​
Tips for Navigating

  • Use the tabs at the top of the page to switch between Home, Get Started, and each product.
  • 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.