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 - JWT tokens, API keys, MFA flows
• Making Requests - Request format, headers, pagination
• Error Handling - HTTP status codes, error responses
• WebSocket Connection - Real-time data setup

API Domains

• Core Concepts - Core concepts and data model
• Authentication - Sessions, login, API keys
• Accounts - Client accounts, sub-accounts
• Trading - Exchange orders, OTC trades
• Assets - Instruments, pairs, prices, balances
• Funding - Deposits, withdrawals, transfers, settlement lines
• Custody - Holdings, addresses

Use Cases

Step-by-step guides for common workflows:

1. Authentication
2. API Key Creation
3. Wallet Information
4. Trading Data
5. OTC Trading
6. Deposits & Withdrawals
7. Account Information
8. Settlement Lines

WebSocket

• WebSocket Topics - Available real-time data streams