Overview
Backend REST API for UI/Dashboard communication. Covers configuration management, reporting, user administration, and strategy management.
Contract
Consumers
- UserInterfaceDashboard
- ExternalClients
Types
| Name | Base | Constraints / Values | Description |
|---|---|---|---|
| ApiResponse | object | — | Standard JSON response envelope |
Operations
GET /positions
Return all current position snapshots.
Returns: list[Position]
GET /orders
Return all orders (open and closed).
Returns: list[Order]
GET /audit
Return audit event log.
| Parameter | Type | Required | Constraints |
|---|---|---|---|
event_type | str | — | — |
component | str | — | — |
Returns: list[AuditEvent]
POST /platform/start
Start the trading platform (paper trading mode).
| Parameter | Type | Required | Constraints |
|---|---|---|---|
symbols | list[str] | ✓ | — |
ticks | int | — | — |
Returns: ApiResponse
POST /platform/stop
Stop the trading platform.
Returns: ApiResponse