Start Tick History Replay

Start the replay of historical tick data for backtest (Foundry only).

post

Starts the replay of previously fetched tick history for backtest execution. This method is only available in Foundry environments and will return an error in Trading environments. The replay drives the system identically to ticks arriving in a live trading environment, allowing the algo to operate off tick and derived/aggregate data as it would in live. In Foundry: Full Stack environments, replay is driven by the backtesting engine. In Foundry: Data Cloud Only environments, replay is driven by the user via this REST API.

Query parameters
datasetstring · enumOptional

The dataset for which the tick replay should be started

Default: SIPPossible values:
datestringRequired

The date for which to replay tick history (format: YYYY-MM-DD)

rateTypestring · enumOptional

The rate type for replay: Exact (replay at actual speed) or MultipleOfActual (replay at a multiple of actual speed)

Default: ExactPossible values:
rateinteger · int64Optional

The replay rate multiplier (only applies when rateType is MultipleOfActual). For example, rate=10 means replay at 10x actual speed

Default: 1
startTimestringOptional

The start time within the day for replay (format: HH:MM:SS). If not specified, replay starts from the beginning of the trading day

startPointstringOptional

Alternative way to specify start time as milliseconds since start of day

durationstringOptional

The duration of replay (format: HH:MM:SS). If not specified, replay continues until end of trading day

Responses
200

The successful response indicates the replay has started successfully

application/json
Responseobject
post
/datafye-api/v1/backtest/history/ticks/replay/start
PreviousReset StateNextIs Tick Replay Running

Last updated