Tradestory

Tradestory Docs

Value Data Items are probably the most commonly used data item you will use in your stories.  It allows you to simply enter a value to sections of Story Items and Conditions that require a value.

To edit the value, click on the Value to being up the settings for this input field.

Data Item: Value

Calculated Values can be created from other Data Items.

By default the calculated value adds to the screen with a SUM calculation.  This is the ‘operator’ used for the calculation of the objects below it.  Click on the Calculated Field title to bring up the other types of calculations available in the toolbox.

 - Subtract the values provided from each other.

 - Multiply the values provided together.

- Divide the values provided by each other.

 - Provide a mean average of the provided values.

 - Get the minimum value from the list of provided values.

 - Get the maximum value from the list of provided values.

 - Join together the values provided as a string. (eg ‘hello’ and ‘world’ = ‘helloworld’).

To add one or more values to the list of values used in the calculation, click on the green ‘plus’ icon underneath the Calculated Field title.

This will bring up the Data Item toolbox where you can select the Data Item you want to add to the list of values in the calculation.  This can be other Value items, or any of the other Data Items available.  

For example, you could have a calculated field using another calculated field - 

You can make some fairly complex calculations with these basic building blocks.

Data Item: Calculated Value

Access values from data sent in a webhook.  When data is sent to your webhook endpoints, it can contain a valid JSON payload containing data.  For example, this can be information like the price of a stop-loss or number of points take-profit coming from an external indicator alert.  This is really powerful and allows you to use dynamic information in your TradeStory strategies coming in externally.

For more information about setting up Webhooks and sending data in Webhooks, please refer to the 

Clicking on the Webhook Data title will bring up the settings panel for this, where you can input the path to the data in the webhook.

Webhook data should be accessed in what developers call ‘dot-notation’.  Don’t worry this is not complicated.  It's just a way of telling TradeStory where exactly in the data to get the item we are referring to.

For example: Let's say the following data is sent in a Webhook to TradeStory:

{
 "data": {
   "price": {
     "open": 123.40,
     "close": 124.65
   }
 }
}


.. and we wish to access the ‘open’ value of 123.40 in our Webhook Data Item we would set the webhook value as follows.

given the data in the webhook above, we could log out the value of the close price with a Log Story Item that uses a Webhook Endpoint Data Item for its value.

 Webhook Data Items can only refer to data provided in the current webhook that triggered the current story execution. If you need to refer to webhook data posted to one of your endpoints outside of the current story execution, then you can use 

Data Item: Webhook Data

Get the value from a webhook that triggered most recently, for a specific strategy and webhook endpoint. 

To select the webhook from specific strategy and endpoint, click on the green ‘plus’ icon which brings up the Choose Webhook panel.

 Item if you need access to data provided in a webhook that triggers the current story execution.

Data Item: Most Recent Webhook Data

Context Data Item allows you to retrieve the value from a previously set context variable. (See 

Context data is only present for the time it takes the current Story to run, which makes this an ideal way to set temporary variables, which other Story Items within the same Story can use in their operations.

Click on the Context Data title to bring up the settings, where you can enter the path to the data you are referring to (if using structured json data) or simply the name of the context variable (if using variable names).

Data Item:Context Data

Get the value from a Strategy Variable, using its variable name and Strategy.

 and how to set them for more information)

Click on the Variable Data title to bring up the settings, where you can enter the name of the variable you need to get the value from.

For example: If there is a Strategy Variable called DAILY_MAX_TRADES, I can refer to this in the Name.

You can also click on the green ‘plus’ icon to bring up the strategy selection toolbox, should you need to specify a variable that is not within the current Story’s Strategy.

By default, the Data Item will assume your strategy variable exists on the same strategy that the current story belongs to.

Data Item:Variable Data

Get an open position on an account by its reference.

This data item returns a structured JSON response, which you can refer to in other Story Items and Data Items that can accept this type of data (For example, 

{
 "id": "string",
 "direction": "string enum | buy,sell",
 "symbol": "string",
 "contract_id": "string | null",
 "volume": number,
 "entry_price": number,
 "stop_loss": number,
 "take_profit": number,
 "profit": number,
 "unrealized_profit": number,
 "realized_profit": number,
 "commission": number,
 "created_at": "string | DateTime"
}


 Your story may wish to get the details of an open position, save it to a variable or context variable, which can then be accessed by other items that allow dot-notation data access.  The following example gets a position data, saves it to context, so that we can log out the profit for the open position.

Data Item:Get Open Position

Get a list of open positions on an account for symbols.

To select an account, click on the green ‘plus’ icon to bring up the Account Selection toolbox.

To filter positions to only certain symbols, you can click on the “Symbols” title to bring up the Symbols panel.  Enter the symbol name and click Add to add one or more symbols to the filter. (be careful to enter the symbol in the exact way that your broker requires it, which may be case sensitive).

This data item returns an array of Position data items (See 

[
 {position},
 {position},
 {position},
 {position}
]


 Looping through each open GBPUSD position on an account, and if a position is over 500.00 in profit, close it.

Data Item:Get Open Positions List

Get the data from an open Pending Order on an account by its reference.

To select an account, click on the green ‘plus’ icon and select an account.

The reference can be any Data Item, by default a Value item.  Click on the Value to edit it to set the value for your pending order reference.

The Data Item returns a Pending Order object data structure:

{
 "id": "string",
 "type": "string | enum ORDER_TYPE",
 "status": "string | enum ORDER_STATUS",
 "symbol": "string",
 "contract_id": "string | null",
 "position_id": "string",
 "volume": number,
 "price": number,
 "filled_volume": number,
 "created_at": "string | DateTime"
}


buy_market
sell_market
buy_limit
sell_limit
buy_stop
sell_stop
buy_stop_limit
sell_stop_limit
close_by


requested
open
partially_filled
filled
cancelled
rejected
expired


Data Item:Get Pending Order

Get a list of pending orders on an account by symbols.

To select an account, click on the green ‘plus’ icon to bring up the account selection toolbox.

To add symbols to your filter, click on the Symbols title and add one or more symbols by entering your symbol name into the value box and clicking Add.(Be careful to add the symbol name exactly as your broker expects it, which may be case sensitive).

This Data Item returns an array of Pending Order objects (See 

[
 { order },
 { order },
 { order },
 { order }
]


Data Item:Get Pending Orders List

Get a list of economic news events, filtered by impact levels, timing, currencies, countries and keywords.

Click on any of the items to add timings, impact levels, currencies, and countries in the settings toolbox.

This returns an array of Economic News Events:

[
 { event },
 { event },
 { event },
 { event },
 ...
]


The shape of each Economic News Event is as follows:

{
 "event_date":  "string | DateTime",
 "country": "string | US,EU,FR...",
 "event":  "string | Event Title",
 "currency":  "string | USD",
 "previous":  numeric (previous value),
 "estimate":  numeric (estimated value),
 "actual":  numeric (actual value),
 "change":  numeric (actual change from previous),
 "impact":  "string | enum, high, medium, low",
 "change_percentage": numeric (percent change)
}


Data Item:Get News Events List

Get the balance or equity value for an account.

Click on the green ‘plus’ icon to select an account.

To select if you want to get the Balance or Equity, click on the Type section to being up the selection.  Balance is the actual account balance of the base currency of your account.  Equity depends on each broker, but usually Equity takes into account unrealised profit and loss.

Data Item:Get Account Balance Information

Every Data Item contains a rounding option if you need to apply rounding to values before they are used in any calculations. (or indeed to round the values of calculations).

To enable rounding on a Data Item, simply tick the Use Rounding option where you will be presented with more options.

 Some brokers will place a limit on the number of decimal places a position size can have when sending orders.  If the position size is being calculated within a TradeStory using dynamic data, or from other external data sources, it may be necessary to ensure this has the set number of decimal places before TradeStory sends the order to your broker.  

Rounding values in Data Items

Item allows you to access the current and latest quotation for a symbol on an account.

In the settings panel, you can request the type of quote you wish to access - 

The Bid is the current price the market is willing to offer to buy the symbol.  The Ask is the current price the market is offering to sell the symbol.  

Bid and Ask types will return a value for the quotation.  Data will return a json structure containing all of the data, which can be used in other data items or stories in the following format - 

{
        "bid": 123.45,
        "ask": 678.45,
}

Data Item: Get Quote

The Get Candle Data Item allows you to access information about the current candle for a symbol, on an account, for a specific timeframe. 

In the candle settings panel, you can select the data type and candle timeframe you require.

All of the candle data types return a value for the current candle, Except for 

which returns a json structure which can be used in other data items or contexts - 

{
        "open": 1400.00
        "close": 1450.00,
        "high": 1455.00,
        "low": 1439.00
        "volume": 457834
}

Data Item: Get Candle

The Volume % Risk Calculator data item is an item you can add to your Volume settings when creating 

.  It allows you to automatically calculate the position/lot size (volume) for a new order based upon a percentage of your account balance or equity.

Note: you must have a stop loss configured on your order for this feature to work.

To add this to your new order story, click the green 'add' button in the VOLUME section and select 

Here you can configure your risk percentage based upon your balance or equity.

 Tick this box if you wish to set the value of the ticksize for your brokers contract.  When this is ticked, you will be able to input your own tick value.

 Default 2 decimal places.  This is how the final volume of the position will be rounded.

Tick Value and notes about different brokers.

When the risk calculator runs, it attempts to get the symbol specification for your trade directly from your broker.  This includes details like ticksize, contract size and multiples etc.  Usually this is correct and you do not have to change this.  However, there are certain types of symbols or contracts that do not provide this as standard.  One example is for some Futures contract. (Like CME NQ).  Rather than being able to calculate the tick value from the ticksize and contract size, some products have an industry standard tick value.

One example is NQ Nasdaq 100 futures.  It has a standard tick value of $5 per tick. In this instance you would be able to override the tick calculations and add your own tick value in the calculator.  

- Its always a good idea to check the symbol or specification you trade to make sure these calculations make sense.

Data Item: Volume % Risk Calculator

The Volume Fixed Risk Calculator data item is an item you can add to your Volume settings when creating 

.  It allows you to automatically calculate the position/lot size (volume) for a new order based upon a fixed amount of risk.

Here you can configure your risk value (this is the amount of money in the base currency of your account you are willing to risk)