Skip to content

ScaleTrade Report API

A flexible analytics interface for advanced trade reporting and system insights.

Overview

ScaleTrade Report API is a developer-oriented framework for extending the reporting capabilities of the ScaleTrade trading engine.
It provides a set of functions, structured data definitions, identifiers, and virtual report interfaces, enabling developers to create custom report modules that integrate seamlessly with the platform.

Unlike traditional Windows-based APIs, ScaleTrade Report API is fully native to Linux, optimized for high-performance analytics and scalable deployment in distributed brokerage environments.

Use Cases

  • Building custom financial and operational reports
  • Integrating real-time analytics dashboards
  • Automating regulatory and compliance reporting
  • Generating custom performance metrics for clients and managers

Purpose

The Report API enables developers to create modular report plugins that expand the analytical functionality of the ScaleTrade server.
These modules can read configuration files, access live and historical databases, and retrieve current system states of users, managers, and trades.

By leveraging the API, you can build tailored reports and visualization tools that fit specific business or compliance needs.

  • Dynamic Data Access
    Read configurations, trade databases, and live client information directly from the ScaleTrade backend.
  • Visual Analytics
    Create graphical reports and dashboards with integrated Rechart SVG visualizations.
  • Tabular Exports
    Generate sortable, filterable tables accessible via the Manager Terminal or REST interface.
  • Built for Linux
    Report modules are compiled and executed in Linux environments, ensuring reliability and security.

Architecture and Integration

Each report is implemented as a dynamic module (.so) built for Linux.
The ScaleTrade Report API defines a virtual interface that must be implemented by your plugin for it to be recognized by the trading server.

Plugin Lifecycle

  1. The report module is registered in the server configuration.
  2. On startup, ScaleTrade loads all active report plugins dynamically.
  3. The system invokes your report interface methods for data collection and rendering.
  4. Reports can return either data tables or rendered graphics.
flowchart LR
  A[ScaleTrade Core] --> B(("Report API"))
  B --> C["Custom Report Plugin (.so)"]
  C --> D["Table Output"]
  C --> E["Rechart SVG Graphics"]