Executors

Get Performance Report

Changed on

Get a performance report for executors.

Aggregates metrics from all completed executors (optionally filtered by controller_id):

  • Realized PnL (from completed executors, excluding POSITION_HOLD close type)
  • Unrealized PnL (from active executors + position holds)
  • Global PnL (realized + unrealized)
  • Fees and volume totals
  • Win rate and Sharpe ratio
  • Breakdown by executor type
  • Active position count

Query parameters:

  • controller_id: Filter by controller ID (omit for all controllers)
get/executors/performance

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/executors/performance
  • Auth
    HTTP basic

Query parameters

controller_idstring nullable

Response

Successful Response

controller_idstring nullable

Controller ID filter (None = all)

total_executorsinteger required

Total executor count

by_statusobject required

Executor count by status

pnl_total_quotenumber required

Realized PnL from completed executors in quote currency

unrealized_pnl_quotenumber required

Unrealized PnL from active executors and position holds

global_pnl_quotenumber required

Global PnL (realized + unrealized)

pnl_pct_avgnumber required

Average PnL percentage across completed executors

fees_total_quotenumber required

Total cumulative fees in quote currency

volume_total_quotenumber required

Total volume traded in quote currency. Volume GENERATED, not capital deployed: an LP position's deposit is excluded, and the volume its range actually saw is derived from the fees it earned.

win_ratenumber required

Win rate: fraction of completed executors with positive PnL

sharpe_rationumber nullable

Sharpe ratio of PnL returns (null if <2 executors)

active_positionsinteger required

Number of active position holds

Changes