> This page is for Taurus PRIME.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://taurushq.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://taurushq.ferndocs.com/_mcp/server.

# Introduction

# PRIME Front Office API Documentation

Welcome to the PRIME Front Office API documentation. This covers the REST and WebSocket APIs for traders and investors.

## Real-Time Updates

PRIME provides real-time updates via **WebSocket only**. Webhook callbacks are not supported. To receive notifications about order executions, balance changes, deposits, and other events, connect to the WebSocket API and subscribe to the relevant topics.

## Core Concepts

Before using the API, understand these key concepts:

* **Trading Venues**: Exchange vs OTC trading modes
* **Entity Hierarchy**: Users, Client Accounts, and Sub-Accounts (Portfolios)
* **Instruments & Pairs**: Tradable assets and their trading relationships
* **Permissions**: Role-based access control and operation permissions

## Quick Links

### Getting Started

* [Authentication](/prime/docs/api-gett-authentication) - JWT tokens, API keys, MFA flows
* [Making Requests](/prime/docs/api-gett-making-requests) - Request format, headers, pagination
* [Error Handling](/prime/docs/api-gett-error-handling) - HTTP status codes, error responses
* [WebSocket Connection](/prime/docs/api-gett-websocket-connection) - Real-time data setup

### API Domains

* [Core Concepts](/prime/docs/api-doma-core-concepts) - Core concepts and data model
* [Authentication](/prime/docs/api-doma-auth-sessions) - Sessions, login, API keys
* [Accounts](/prime/docs/api-doma-acco-accounts) - Client accounts, sub-accounts
* [Trading](/prime/docs/api-doma-trad-trading) - Exchange orders, OTC trades
* [Assets](/prime/docs/api-doma-asse-assets) - Instruments, pairs, prices, balances
* [Funding](/prime/docs/api-doma-fund-funding) - Deposits, withdrawals, transfers, settlement lines
* [Custody](/prime/docs/api-doma-cust-custody) - Holdings, addresses

### Use Cases

Step-by-step guides for common workflows:

1. [Authentication](/prime/docs/api-usec-01-authentication)
2. [API Key Creation](/prime/docs/api-usec-02-api-key-creation)
3. [Wallet Information](/prime/docs/api-usec-03-wallet-information)
4. [Trading Data](/prime/docs/api-usec-04-trading-data)
5. [OTC Trading](/prime/docs/api-usec-05-otc-trading)
6. [Deposits & Withdrawals](/prime/docs/api-usec-06-deposits-withdrawals)
7. [Account Information](/prime/docs/api-usec-07-account-information)
8. [Settlement Lines](/prime/docs/api-usec-08-settlement-lines)

### WebSocket

* [WebSocket Topics](/prime/docs/api-webs-topics) - Available real-time data streams