API Reference

All HTTP endpoints called from the React SPA. Scanned from client/src/hooks/useApi.ts at build time — re-run npm run sync-api to refresh.

Endpoints133

Groups15

GET / POST76 / 37

SourceuseApi.ts

How this list is generated

The build-time script scripts/parse-api.mjs walks useApi.ts looking for export const … = … apiFetch<…>('/path', { method }) calls. The method defaults to GET; the group label comes from the first URL path segment. Source line numbers are 1-indexed and link back to client/src/hooks/useApi.ts.

Three handlers are special-cased because they use raw fetch() rather than apiFetch: login, exportSession, exportBacktest.

Filters

Method

Groups

Algorithms (deprecated) (5)
Analytics (12)
Auth (21)
Backtest (13)
Calibration (34)
Dashboard (2)
Health (1)
Infrastructure (2)
Instruments (7)
Logs (4)
Logs?since_id={sinceId}&limit={limit} (1)
Replay (2)
Services (5)
Simulator (6)
Trading (18)

133 endpoints in 15 groups

GET/api/v1/algorithmslistAlgorithms()L680
GET/api/v1/algorithms/{instrument}/statusgetAlgorithmStatus(instrument)L683
POST/api/v1/algorithms/{instrument}/stopstopAlgorithm(instrument)Stop AlgorithmL699
GET/api/v1/algorithms/instrumentslistInstruments()L705
POST/api/v1/algorithms/startstartAlgorithm()Start AlgorithmL686

DELETE/api/v1/session-analytics/{sessionId}?retain_results={retainResults}deleteSession(sessionId, retainResults)L1584
GET/api/v1/session-analytics/{sessionId}/distribution?num_bins={numBins}getSessionDistribution(sessionId, numBins)L1674
GET/api/v1/session-analytics/{sessionId}/exportexportSession(sessionId)Export SessionL1639
GET/api/v1/session-analytics/{sessionId}/fillsgetSessionFills(sessionId)L1630
GET/api/v1/session-analytics/{sessionId}/latencygetSessionLatency(sessionId)L1677
GET/api/v1/session-analytics/{sessionId}/quotesgetSessionQuotes(sessionId)L1633
GET/api/v1/session-analytics/{sessionId}/resultsgetSessionResults(sessionId)L1671
GET/api/v1/session-analytics/aggregate/{symbol}?mode={mode}getAggregateSessionResults(symbol, mode)L1680
GET/api/v1/session-analytics/aggregate/{symbol}/distribution?mode={mode}&level={level}&num_bins={numBins}getAggregateSessionDistribution(symbol, mode, level, numBins)L1683
DELETE/api/v1/session-analytics/archived/{sessionId}deleteArchivedSession(sessionId)L1595
GET/api/v1/session-analytics/archived/list${mode ? listArchivedSessions(mode?)L1590
GET/api/v1/session-analytics/list?mode={mode}listTradingSessions(mode)L1581

DELETE/api/v1/auth/audit-logdeleteAuditEntries(ids)L1779
GET/api/v1/auth/audit-log/actorsfetchAuditActors()L1776
GET/api/v1/auth/audit-log/datesfetchAuditDates()L1773
GET/api/v1/auth/audit-log${qs ? fetchAuditLog(params)L1758
POST/api/v1/auth/extend-sessionextendSession()L365
POST/api/v1/auth/force-disconnectforceDisconnect(username, password)L426
POST/api/v1/auth/loginlogin(username, password)User LoginL263
POST/api/v1/auth/logoutlogoutApi()L415
GET/api/v1/auth/megetCurrentUser()L320
GET/api/v1/auth/policy-groupslistPolicyGroups()L501
POST/api/v1/auth/refreshrefreshToken(refreshTokenStr)L323
POST/api/v1/auth/registerregister()L307
GET/api/v1/auth/session-infogetSessionInfo()L371
GET/api/v1/auth/session-statusgetSessionStatus()L388
GET/api/v1/auth/timeout-configgetTimeoutConfig()L377
GET/api/v1/auth/userslistUsers()L471
POST/api/v1/auth/userscreateUser(data)L474
DELETE/api/v1/auth/users/{username}deleteUser(username)L480
GET/api/v1/auth/users/{username}/groupsgetUserGroups(username)L504
PUT/api/v1/auth/users/{username}/groupsupdateUserGroups(username, groups)L507
GET/api/v1/auth/vault-statusgetVaultStatus()L412

GET/api/v1/backtest/{backtestId}/exportexportBacktest(backtestId)Export BacktestL1655
GET/api/v1/backtest/{backtestId}/fillsgetBacktestFills(backtestId)L1636
GET/api/v1/backtest/{id}getBacktest(id)L1477
GET/api/v1/backtest/{id}/distribution?level={level}&num_bins={numBins}getBacktestDistribution(id, level, numBins)L1531
GET/api/v1/backtest/{id}/resultsgetBacktestResults(id)L1498
POST/api/v1/backtest/{id}/startstartBacktest(id)L1480
POST/api/v1/backtest/{id}/stopstopBacktest(id)L1486
DELETE/api/v1/backtest/{id}${retainResults ? deleteBacktest(id, retainResults)L1492
GET/api/v1/backtest/archivedgetArchivedBacktests()L1549
DELETE/api/v1/backtest/archived/{id}deleteArchivedBacktest(id)L1552
GET/api/v1/backtest/listlistBacktests()L1474
POST/api/v1/backtest/registerregisterBacktest(config, resolved_dates)L1468
POST/api/v1/backtest/resolve-datesresolveBacktestDates()L1457

GET/api/v1/calibration/asset-check/{symbol}?start_date={startDate}&end_date={endDate}&scheduler_mode={schedulerMode}fetchCalibrationAssetCheck()L1964
GET/api/v1/calibration/automationfetchAutomationConfigs()L2066
GET/api/v1/calibration/automation/{symbol}fetchAutomationConfig(symbol)L2069
PUT/api/v1/calibration/automation/{symbol}updateAutomationConfig(symbol, config)L2072
DELETE/api/v1/calibration/automation/{symbol}deleteAutomationConfig(symbol)L2078
POST/api/v1/calibration/automation/{symbol}/force-triggerforceTriggerAutomation()L2177
POST/api/v1/calibration/automation/{symbol}/force-trigger-previewforceTriggerPreview()L2163
GET/api/v1/calibration/automation/{symbol}/params/{calType}fetchAutoCalibrationConfig(symbol, calType)L1903
POST/api/v1/calibration/automation/{symbol}/params/{calType}saveAutoCalibrationConfig(symbol, calType, config)L1906
GET/api/v1/calibration/automation/defaultsfetchAutomationDefaults()L2063
GET/api/v1/calibration/automation/history/recent?{params}fetchAutomationRecentRuns(limit, opts?)L2240
GET/api/v1/calibration/automation/pipeline/{pipelineId}fetchPipelineStatus(pipelineId)L2189
DELETE/api/v1/calibration/automation/pipeline/{pipelineId}deletePipeline(pipelineId)L2214
POST/api/v1/calibration/automation/pipeline/{pipelineId}/retryretryPipeline(pipelineId)L2203
POST/api/v1/calibration/automation/pipeline/{pipelineId}/retry-with-current-configretryPipelineWithCurrentConfig(pipelineId)L2208
POST/api/v1/calibration/automation/pipeline/{pipelineId}/stopstopPipeline(pipelineId)L2198
GET/api/v1/calibration/automation/pipelines/activefetchActivePipelines()L2192
GET/api/v1/calibration/automation/pipelines/recent?limit={limit}fetchRecentPipelines(limit)L2195
GET/api/v1/calibration/automation/summaryfetchAutomationSummary()L2060
GET/api/v1/calibration/configfetchCalibrationConfigs()L1886
GET/api/v1/calibration/config/{calibrationType}/{symbol}fetchCalibrationConfig(symbol, calibrationType)L1889
POST/api/v1/calibration/config/{calibrationType}/{symbol}saveCalibrationConfig(symbol, calibrationType, config)L1892
DELETE/api/v1/calibration/config/{calibrationType}/{symbol}deleteCalibrationConfig(symbol, calibrationType)L1898
GET/api/v1/calibration/data-status/{symbol}fetchCalibrationDataStatus(symbol)L1944
GET/api/v1/calibration/defaults/{type}fetchCalibrationDefaults(type)L1912
GET/api/v1/calibration/docker-imagesfetchCalibrationDockerImages()L1877
GET/api/v1/calibration/microprice-dependency/{symbol}fetchMicropriceDependency(symbol)L1986
POST/api/v1/calibration/runstartCalibrationRun(request)L1921
GET/api/v1/calibration/runs/{runId}fetchCalibrationRun(runId)L1935
DELETE/api/v1/calibration/runs/{runId}deleteCalibrationRun(runId)L1941
POST/api/v1/calibration/runs/{runId}/stopstopCalibrationRun(runId)L1938
GET/api/v1/calibration/runs${qs ? fetchCalibrationRuns(symbol?, status?)L1927
GET/api/v1/calibration/symbolsfetchCalibrationSymbols()L1883
GET/api/v1/calibration/validate-timezone/{tz}validateCalibrationTimezone(tz)L1880

POST/api/v1/dashboard/refreshrefreshDashboard()L756
GET/api/v1/dashboard/summarygetDashboardSummary()L753

GET/api/v1/healthgetHealth()L514

GET/api/v1/infrastructurefetchInfrastructure()L2292
POST/api/v1/infrastructure/refreshrefreshInfrastructure()L2295

GET/api/v1/instruments/{symbol}getInstrument(symbol)L649
PUT/api/v1/instruments/{symbol}updateInstrument(symbol, data)L663
POST/api/v1/instruments/{symbol}/promotepromoteExperiment(symbol, experimentId)L1238
DELETE/api/v1/instruments/{symbol}/promoteunpromoteExperiment(symbol)L1244
GET/api/v1/instruments/configgetInstrumentsConfig()L643
GET/api/v1/instruments/promotedgetPromotedExperiments()L1235
GET/api/v1/instruments/symbolsgetInstrumentSymbols()L646

DELETE/api/v1/logsclearServerLogs()L791
GET/api/v1/logs/countgetLogCount()L788
DELETE/api/v1/logs/tradingclearTradingServerLogs()L797
GET/api/v1/logs/trading?since_id={sinceId}&limit={limit}getTradingLogs(sinceId, limit)L794

GET/api/v1/logs?since_id={sinceId}&limit={limit}getLogs(sinceId, limit)L785

GET/api/v1/replay/daysgetReplayDays()L589
GET/api/v1/replay/daysfetchCalibrationReplayDates()L1918

GET/api/v1/servicesfetchServices()L1711
PUT/api/v1/servicesupdateServiceUrls(services, string>)L1717
POST/api/v1/services/customaddCustomService(service)L1720
DELETE/api/v1/services/custom/{serviceId}deleteCustomService(serviceId)L1723
GET/api/v1/services/definitionsfetchServiceDefinitions()L1714

PUT/api/v1/simulator/configupdateSimulatorConfig(config, unknown>)L576
POST/api/v1/simulator/pausepauseSimulator()L570
POST/api/v1/simulator/resumeresumeSimulator()L573
POST/api/v1/simulator/startstartSimulator(config?, unknown>)Start SimulatorL557
GET/api/v1/simulator/statusgetSimulatorStatus()L554
POST/api/v1/simulator/stopstopSimulator()Stop SimulatorL564

GET/api/v1/trading/activegetActiveTradingSessions()L1054
GET/api/v1/trading/algorithmsgetConfiguredAlgorithms()L1117
GET/api/v1/trading/algorithms/{algorithmId}getConfiguredAlgorithm(algorithmId)L1123
DELETE/api/v1/trading/algorithms/{algorithmId}deleteConfiguredAlgorithm(algorithmId)L1129
GET/api/v1/trading/algorithms/{algorithmId}/configgetAlgorithmConfig(algorithmId)L1164
POST/api/v1/trading/algorithms/{algorithmId}/start${tradingMode ? startConfiguredAlgorithm(algorithmId, tradingMode?)L1139
POST/api/v1/trading/algorithms/{algorithmId}/stop?emergency={emergency}stopConfiguredAlgorithm(algorithmId, emergency)L1148
POST/api/v1/trading/algorithms/registerregisterAlgorithm(config, trading_mode)Set AlgorithmL1106
GET/api/v1/trading/calibration-assets/{symbol}getCalibrationAssets(symbol)L1187
GET/api/v1/trading/experiments?${symbol ? listTradingExperiments(symbol?, productionOnly)L1015
GET/api/v1/trading/microprice-status/{symbol}getMicropriceStatus(symbol)L1204
GET/api/v1/trading/session-by-symbol/{symbol}getTradingSessionBySymbol(symbol)L1060
GET/api/v1/trading/session/{sessionId}getTradingSession(sessionId)L1057
POST/api/v1/trading/startstartTrading(config)Start TradingL1026
POST/api/v1/trading/stopstopTrading(sessionId, emergency)Stop TradingL1033
POST/api/v1/trading/stop-all?emergency={emergency}stopAllTrading(emergency)L1043
GET/api/v1/trading/symbols?production_only={productionOnly}getTradingSymbols(productionOnly)L1012
POST/api/v1/trading/validate-experimentvalidateExperiment(request)L1020

How this list is generated

Filters

Algorithms (deprecated)

Analytics

Auth

Backtest

Calibration

Dashboard

Health

Infrastructure

Instruments

Logs

Logs?since_id={sinceId}&limit={limit}

Replay

Services

Simulator

Trading