Available translations
loading results
Trading Episode
Episode is the object that handles the information corresponding to the whole run of the trading bot—beginning to end—between the specified initial datetime and final datetime, in the time range parameter of the trading session.
Content
In other words, episode is the context framed between the datetimes that make up the whole trading session, as per the session's configuration. As such, an episode keeps track of—and accumulates—the results of all positions entered throughout a complete run of a trading session.
In this section of the hierarchy, you have access to:
- running balances and overall performance metrics denominated in both the base and quoted assets;
- counters, such as the number of positions taken, orders placed, hits, fails, and so on;
- statistics, such as performance metrics consolidating both assets, number of days in the episode, or user-defined statistics;
- the distance to certain events, such as the number of candles to the last take position event, or the last create order event;
- rates describing each candle in the episode, such as the open, close, min and max rates.
Note: When working on sub-hour time frames, the system works with daily files, therefore, in such context, a Trading Episode lasts 24 hours. If the Trading Session spans across natural days, then you will get one Trading Episode object per day. Notice that this doesn't affect the structure of nodes of the Trading Engine hierarchy.
Trading Episode Menu
The Trading Episode node has the following Node Menu items:
The Add Missing Children menu item has the following properties:
- action: Add Missing Children
- label: Add Missing Children
- relatedUiObject: Trading Parameters
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that Trading Episode already has the required child type that the menu item may add, and only that child is allowed for that case.
Trading Episode Children
The Trading Episode node has the following childrenNodesProperties:
The Serial Number node property features the following properties:
- name:
serialNumber
- type: node
- childType: Serial Number
- autoAdd: true
The Identifier node property features the following properties:
- name: identifier
- type: node
- childType: Identifier
- autoAdd: true
The Begin node property features the following properties:
- name: begin
- type: node
- childType: Begin
- autoAdd: true
The End node property features the following properties:
- name: end
- type: node
- childType: End
- autoAdd: true
The Begin Rate node property features the following properties:
- name:
beginRate
- type: node
- childType: Begin Rate
- autoAdd: true
The End Rate node property features the following properties:
- name:
endRate
- type: node
- childType: End Rate
- autoAdd: true
The Status node property features the following properties:
- name: status
- type: node
- childType: Status
- autoAdd: true
The Exit Type node property features the following properties:
- name:
exitType
- type: node
- childType: Exit Type
- autoAdd: true
The Head Of The Market node property features the following properties:
- name:
headOfTheMarket
- type: node
- childType: Head Of The Market
- autoAdd: true
The Process Date node property features the following properties:
- name:
processDate
- type: node
- childType: Process Date
- autoAdd: true
The Episode Base Asset node property features the following properties:
- name:
episodeBaseAsset
- type: node
- childType: Episode Base Asset
- autoAdd: true
The Episode Quoted Asset node property features the following properties:
- name:
episodeQuotedAsset
- type: node
- childType: Episode Quoted Asset
- autoAdd: true
The Trading Episode Counters node property features the following properties:
- name:
tradingEpisodeCounters
- type: node
- childType: Trading Episode Counters
- autoAdd: true
The Trading Episode Statistics node property features the following properties:
- name:
tradingEpisodeStatistics
- type: node
- childType: Trading Episode Statistics
- autoAdd: true
The Distance To Trading Event node property features the following properties:
- name:
distanceToTradingEvent
- type: node
- childType: Distance To Trading Event
- autoAdd: true
The Candle node property features the following properties:
- name: candle
- type: node
- childType: Candle
- autoAdd: true
The Cycle node property features the following properties:
- name: cycle
- type: node
- childType: Cycle
- autoAdd: true
The User Defined Variables node property features the following properties:
- name:
userDefinedVariables
- type: node
- childType: User Defined Variables
- autoAdd: false
Trading Episode Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Trading Episode with other nodes:
Compatible Types: