TraderEvolution

https://traderevolution.com/documentation/
Admin
TraderEvolution is a comprehensive multi-asset trading platform for brokers, banks, and prop firms,...
Tokens:4,514
Snippets:29
Trust Score:7.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### TraderEvolution Client API

Source: https://traderevolution.com/documentation

Full-featured API for building custom front-ends, algorithmic trading systems, and AI agents on top of the TraderEvolution back-end. Covers the complete trading lifecycle.

```APIDOC
## TraderEvolution Client API

### Description
Full-featured API for building custom front-ends, algorithmic trading systems, and AI agents on top of the TraderEvolution back-end. Covers the complete trading lifecycle.

### Key Features
- **WebSocket**: Real-time subscriptions
- **REST**: Request/response operations
- **MCP**: AI agent layer

### Authentication & Session Management
- Token-based authentication with session lifecycle management.
- Supports multi-account access and role-based permission scopes.

### Market Data Subscriptions
- Real-time quote streaming, Level I and Level II data, trade prints, and historical OHLCV data via WebSocket subscriptions.

### Order Placement & Management
- Place, modify, and cancel all order types.
- Receive real-time execution reports and fill confirmations via event subscriptions.

### Portfolio & Position Data
- Query open positions, closed trades, account balances, and margin state.
- Subscribe to position change events for live portfolio tracking.

### Instrument & Exchange Metadata
- Full instrument specifications including tick size, lot size, margin requirements, trading hours, and exchange details for all connected venues.
```

--------------------------------

### User & Account Management API

Source: https://traderevolution.com/documentation

Programmatically create, update, and manage user accounts, including configuration of account types, trading permissions, leverage, and group assignments.

```APIDOC
## User & Account Management

### Description
Manage user accounts and their configurations via the Back-Office API.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/users`
`/api/v1/accounts`

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier for a user.
- **accountId** (string) - Required - The unique identifier for an account.

#### Query Parameters
- **include** (string) - Optional - Comma-separated list of related entities to include (e.g., `permissions`, `groups`).

#### Request Body
##### Create/Update User
- **username** (string) - Required - The username for the account.
- **email** (string) - Required - The email address of the user.
- **accountType** (string) - Optional - The type of account (e.g., `individual`, `corporate`).
- **tradingPermissions** (array) - Optional - List of trading permissions.
- **leverage** (number) - Optional - The leverage ratio.
- **groupId** (string) - Optional - The identifier of the group the user belongs to.

### Request Example
```json
{
  "username": "testuser",
  "email": "testuser@example.com",
  "accountType": "individual",
  "leverage": 100,
  "groupId": "group_abc"
}
```

### Response
#### Success Response (200)
- **userId** (string) - The unique identifier of the user.
- **username** (string) - The username.
- **email** (string) - The user's email.
- **accountType** (string) - The type of account.
- **tradingPermissions** (array) - List of trading permissions.
- **leverage** (number) - The leverage ratio.
- **groupId** (string) - The identifier of the group.

#### Response Example
```json
{
  "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "username": "testuser",
  "email": "testuser@example.com",
  "accountType": "individual",
  "tradingPermissions": ["trade", "view_reports"],
  "leverage": 100,
  "groupId": "group_abc"
}
```
```

--------------------------------

### FIX Connectivity & Session Configuration

Source: https://traderevolution.com/documentation

Configure FIX sessions with initiator and acceptor modes, heartbeat intervals, sequence number management, and reconnection behavior.

```APIDOC
## FIX Connectivity & Session Configuration

### Description
Details on configuring FIX sessions for trading and data exchange.

### Method
FIX Protocol

### Endpoint
N/A (Configuration is typically done via configuration files or a separate management interface)

### Parameters
- **sessionMode** (string) - Required - `initiator` or `acceptor`.
- **heartbeatInterval** (integer) - Optional - Heartbeat interval in seconds.
- **sequenceNumberManagement** (string) - Optional - Strategy for managing sequence numbers (e.g., `reset_on_logout`, `persistent`).
- **reconnectionBehavior** (object) - Optional - Configuration for reconnection attempts.
  - **maxAttempts** (integer) - Maximum number of reconnection attempts.
  - **delaySeconds** (integer) - Delay between attempts in seconds.

### Request Example
(Configuration is typically file-based or through a GUI, not a direct API request)

### Response
N/A (Session status and logs are typically monitored separately)

### Notes
This section describes the configuration parameters for FIX sessions. Actual implementation details may vary based on the specific FIX engine used.
```

--------------------------------

### Cross Rates & Asset Pricing API

Source: https://traderevolution.com/documentation

Configure cross rate sources, asset currencies, and conversion rules programmatically for consistent multi-currency P&L calculations.

```APIDOC
## Cross Rates & Asset Pricing

### Description
Configure and manage currency exchange rates and asset pricing rules.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/rates/cross`
`/api/v1/pricing/rules`

### Parameters
#### Request Body
##### Cross Rate Configuration
- **baseCurrency** (string) - Required - The base currency (e.g., 'USD').
- **quoteCurrency** (string) - Required - The quote currency (e.g., 'EUR').
- **source** (string) - Required - The source of the exchange rate (e.g., 'ECB', 'Reuters').
- **rate** (number) - Optional - The current exchange rate.

##### Pricing Rule
- **ruleName** (string) - Required - Name of the pricing rule.
- **assetClass** (string) - Required - The asset class this rule applies to.
- **calculationMethod** (string) - Required - Method for calculation (e.g., 'mid_price', 'bid_ask_spread').

### Request Example
```json
{
  "baseCurrency": "USD",
  "quoteCurrency": "EUR",
  "source": "ECB"
}
```

### Response
#### Success Response (200)
- **rateId** (string) - The unique identifier for the cross rate configuration.
- **ruleId** (string) - The unique identifier for the pricing rule.

#### Response Example
```json
{
  "rateId": "rate_usd_eur_1",
  "ruleId": "price_rule_forex_1"
}
```
```

--------------------------------

### Instrument Configuration API

Source: https://traderevolution.com/documentation

Add, modify, and manage trading instruments across all asset classes, including tick size, margin requirements, trading hours, and routing rules.

```APIDOC
## Instrument Configuration

### Description
Manage trading instrument details via the Back-Office API.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/instruments`

### Parameters
#### Path Parameters
- **instrumentId** (string) - Required - The unique identifier for an instrument.

#### Request Body
##### Create/Update Instrument
- **symbol** (string) - Required - The trading symbol (e.g., 'EURUSD').
- **assetClass** (string) - Required - The asset class (e.g., 'Forex', 'Equities').
- **tickSize** (number) - Required - The minimum price fluctuation.
- **marginRequirement** (number) - Required - The margin percentage.
- **tradingHours** (object) - Optional - Defines the trading hours.
- **routingRules** (object) - Optional - Defines the routing logic.

### Request Example
```json
{
  "symbol": "EURUSD",
  "assetClass": "Forex",
  "tickSize": 0.00001,
  "marginRequirement": 1,
  "tradingHours": {
    "open": "00:00",
    "close": "24:00",
    "timezone": "UTC"
  }
}
```

### Response
#### Success Response (200)
- **instrumentId** (string) - The unique identifier of the instrument.
- **symbol** (string) - The trading symbol.
- **assetClass** (string) - The asset class.
- **tickSize** (number) - The minimum price fluctuation.
- **marginRequirement** (number) - The margin percentage.
- **tradingHours** (object) - Trading hours details.
- **routingRules** (object) - Routing logic details.

#### Response Example
```json
{
  "instrumentId": "inst_xyz789",
  "symbol": "EURUSD",
  "assetClass": "Forex",
  "tickSize": 0.00001,
  "marginRequirement": 1,
  "tradingHours": {
    "open": "00:00",
    "close": "24:00",
    "timezone": "UTC"
  },
  "routingRules": {}
}
```
```

--------------------------------

### Commission & Fee Structures API

Source: https://traderevolution.com/documentation

Define and assign commission plans, markup/markdown rules, and swap rates per instrument group or individual account via API.

```APIDOC
## Commission & Fee Structures

### Description
Configure commission and fee structures for instruments and accounts using the Back-Office API.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/commissions`
`/api/v1/fees`
`/api/v1/swaps`

### Parameters
#### Request Body
##### Commission Plan
- **planName** (string) - Required - Name of the commission plan.
- **rate** (number) - Required - The commission rate.
- **type** (string) - Required - Type of commission (e.g., `per_trade`, `percentage`).

##### Fee Structure
- **feeName** (string) - Required - Name of the fee structure.
- **amount** (number) - Required - The fee amount.
- **currency** (string) - Required - The currency of the fee.

##### Swap Rate
- **instrumentId** (string) - Required - The instrument identifier.
- **longRate** (number) - Required - The swap rate for long positions.
- **shortRate** (number) - Required - The swap rate for short positions.

### Request Example
```json
{
  "planName": "Standard Commission",
  "rate": 0.005,
  "type": "percentage"
}
```

### Response
#### Success Response (200)
- **commissionId** (string) - The unique identifier for the commission plan.
- **feeId** (string) - The unique identifier for the fee structure.
- **swapId** (string) - The unique identifier for the swap rate.

#### Response Example
```json
{
  "commissionId": "comm_123",
  "feeId": "fee_456",
  "swapId": "swap_789"
}
```
```

--------------------------------

### FIX Order Management

Source: https://traderevolution.com/documentation

Supports New Order Single, Order Cancel Request, Order Cancel/Replace Request, and Order Status Request, including full execution report flow with partial fills.

```APIDOC
## FIX Order Management

### Description
Handles various order management messages via FIX protocol.

### Method
FIX Protocol

### Endpoint
N/A (Messages are sent over established FIX sessions)

### Messages
- **New Order Single (MsgType=D)**: For submitting new orders.
- **Order Cancel Request (MsgType=F)**: For cancelling existing orders.
- **Order Cancel/Replace Request (MsgType=G)**: For modifying existing orders.
- **Order Status Request (MsgType=H)**: For querying the status of an order.

### Execution Reports
- **Execution Report (MsgType=8)**: Provides details on order fills, including partial fills.

### Notes
This outlines the supported FIX message types for order management. Detailed FIX tag specifications should be consulted for implementation.
```

--------------------------------

### Back-Office API Overview

Source: https://traderevolution.com/documentation

The Back-Office API is a RESTful HTTP/JSON API that provides full CRUD (Create, Read, Update, Delete) operations on all entities within the TraderEvolution platform. It enables automation of broker operations, CRM integration, account onboarding, KYC workflows, and custom reporting.

```APIDOC
## Back-Office API

### Description
A REST API for programmatic control over all administrative and operational functions, including user management, account configuration, instruments, reports, and platform settings. It supports full CRUD operations on all entities.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/*` (example, actual endpoints may vary)

### Parameters
This API supports standard RESTful parameters for CRUD operations.

### Request Body
Supports JSON format for creating and updating entities.

### Response
Returns JSON responses for success and error.

#### Success Response (200)
- **status** (string) - Indicates success.
- **data** (object) - Contains the requested data.

#### Error Response (e.g., 400, 404, 500)
- **status** (string) - Indicates an error.
- **message** (string) - Description of the error.

### Request Example
```json
{
  "operation": "create",
  "entity": "user",
  "data": {
    "username": "newuser",
    "email": "newuser@example.com"
  }
}
```

### Response Example
```json
{
  "status": "success",
  "data": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "newuser",
    "email": "newuser@example.com"
  }
}
```
```

--------------------------------

### FIX DropCopy Session

Source: https://traderevolution.com/documentation

A separate FIX session for post-trade data distribution, routing execution reports independently to prime brokers, risk systems, or compliance infrastructure.

```APIDOC
## FIX DropCopy Session

### Description
Dedicated FIX session for distributing post-trade execution reports.

### Method
FIX Protocol

### Endpoint
N/A (Separate FIX session configuration)

### Functionality
- Routes execution reports (MsgType=8) to specified destinations.
- Allows independent distribution to prime brokers, risk systems, and compliance infrastructure.

### Notes
This session is distinct from the main trading session and is used solely for data dissemination.
```

--------------------------------

### TraderEvolution FIX API

Source: https://traderevolution.com/documentation

Standard FIX protocol connectivity for institutional clients, prime brokers, and algorithmic trading systems. Supports order routing, execution reporting, and post-trade data distribution.

```APIDOC
## TraderEvolution FIX API

### Description
Standard FIX protocol connectivity for institutional clients, prime brokers, and algorithmic trading systems. Supports order routing, execution reporting, and post-trade data distribution.

### Protocol Version
- FIX 4.4

### Features
- **DropCopy**: Post-trade distribution
- **Multi-asset**: Supports all instrument types

### Use Cases
- Connect algorithmic trading systems, prime brokerage infrastructure, or third-party OMS/EMS using industry-standard FIX protocol.

### Sessions
- Order Entry Session
```

--------------------------------

### Reporting & Statement Export API

Source: https://traderevolution.com/documentation

Automate the generation of trade confirmations, account statements, P&L reports, and regulatory reports in structured formats.

```APIDOC
## Reporting & Statement Export

### Description
Automate the generation and export of various financial reports.

### Method
REST (HTTP / JSON)

### Endpoint
`/api/v1/reports/export`

### Parameters
#### Query Parameters
- **reportType** (string) - Required - Type of report (e.g., `trade_confirmation`, `account_statement`, `pnl_report`, `regulatory`).
- **accountId** (string) - Optional - The account identifier for which to generate the report.
- **startDate** (string) - Optional - Start date for the report period (YYYY-MM-DD).
- **endDate** (string) - Optional - End date for the report period (YYYY-MM-DD).
- **format** (string) - Optional - Desired output format (e.g., `csv`, `json`, `pdf`). Defaults to `json`.

### Request Example
```bash
GET /api/v1/reports/export?reportType=account_statement&accountId=acc_001&startDate=2023-01-01&endDate=2023-12-31&format=csv
```

### Response
#### Success Response (200)
- **reportUrl** (string) - A URL to download the generated report.
- **status** (string) - Status of the report generation.

#### Response Example
```json
{
  "reportUrl": "https://example.com/reports/account_statement_acc_001.csv",
  "status": "completed"
}
```
```

--------------------------------

### FIX Market Data Feed

Source: https://traderevolution.com/documentation

Provides FIX Market Data Request and Snapshot/Incremental Refresh messages, supporting Level I quotes and order book data for all connected instruments.

```APIDOC
## FIX Market Data Feed

### Description
Provides real-time market data via FIX protocol.

### Method
FIX Protocol

### Endpoint
N/A (Data is pushed over established FIX sessions)

### Messages
- **Market Data Request (MsgType=V)**: To request market data for instruments.
- **Market Data Snapshot / Incremental Refresh (MsgType=W)**: To receive market data updates.

### Data Supported
- Level I quotes (Best Bid/Offer).
- Order book data (depth of market).

### Notes
This feed provides access to real-time pricing and liquidity information for instruments.
```
Tokens:
Raw