Executors

Get Executor

Changed on

Get detailed information about a specific executor.

Checks active executors in memory first, then falls back to database for completed executors.

Returns full executor information including:

  • Current status and PnL
  • Full configuration
  • Executor-specific custom information
get/executors/{executor_id}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/executors/{executor_id}
  • Auth
    HTTP basic

Path parameters

executor_idstring required

Response

Successful Response

executor_idstring required

Unique executor identifier

executor_typestring nullable required

Type of executor

account_namestring nullable required

Account name

connector_namestring nullable required

Connector name

trading_pairstring nullable required

Trading pair

sidestring nullable

Trade side (BUY/SELL) if applicable

statusstring required

Current status (RUNNING, TERMINATED, etc.)

is_activeboolean required

Whether the executor is active

is_tradingboolean required

Whether the executor has open trades

timestampnumber nullable

Creation timestamp (Unix)

created_atstring nullable

Creation timestamp (ISO format)

close_typestring nullable

How the executor was closed (if applicable)

close_timestampnumber nullable

Close timestamp (Unix)

controller_idstring nullable

ID of the controller that spawned this executor

net_pnl_quotenumber required

Net PnL in quote currency

net_pnl_pctnumber required

Net PnL percentage

cum_fees_quotenumber required

Cumulative fees in quote currency

filled_amount_quotenumber required

Volume traded, in quote currency. For an executor that places orders the amount it filled IS its volume. An LP executor reports the same thing rather than the capital it deposited — depositing trades nothing — deriving it from the fees it earned, which are a fixed fraction of the swaps that crossed its range, and is 0 while it has earned none.

error_countinteger

Number of ERROR-level log entries captured

last_errorstring nullable

Most recent error message, if any

configobject nullable

Full executor configuration

custom_infoobject nullable

Executor-specific custom information

Example response

{
  "account_name": "master_account",
  "connector_name": "binance_perpetual",
  "created_at": "2024-01-15T10:30:00Z",
  "cum_fees_quote": 1.25,
  "executor_id": "abc123...",
  "executor_type": "position_executor",
  "filled_amount_quote": 5000,
  "is_active": true,
  "is_trading": true,
  "net_pnl_pct": 2.5,
  "net_pnl_quote": 125.5,
  "side": "BUY",
  "status": "RUNNING",
  "timestamp": 1705315800,
  "trading_pair": "BTC-USDT"
}

Changes