Interface BotContext

Used to cancel a sell order that closes entire position. Close position is a market order. This action may not trigger fast enough during regular market hours as compared to extended market hours.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.cancelClosePosition();
 }
}
Copy

Used to sell all the shares of a stock at the current market price. This method is useful when the user wants to exit a position quickly and lock in profits or losses.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.closePosition();
 }
}
Copy

getAveragePercentPrice *

Example

// example averagePrice=10
bot.getAveragePercentPrice(1)
// result 11

// example averagePrice=10
bot.getAveragePercentPrice(1, {move: 'down'})
// result 9

// example averagePrice=10
bot.getAveragePercentPrice(1, {move: 'up', shiftPrice: 12, shiftMove: 'up'})
// result 12

// example averagePrice=10
bot.getAveragePercentPrice(1, {move: 'up', shiftPrice: 9, shiftMove: 'up'})
// result 11
Copy

getAveragePrice *

Example

tick = (i, bot, utils) => {
bot.getAveragePrice(...)
...
}
Copy

Used to monitor the duration of time when no position is open when bot is started. This method is useful when the user wants to apply a time-based strategy for monitoring their bot start trigger.

Examples

tick = (i, bot, utils) => {
 ...
 if(bot.noPositionMinutes(5)){
    ...
 }
}
Copy

Reset bot state to wait for new trigger:

tick = (i, bot, utils) => {
 ...
 if(bot.noPositionMinutes(5)){
    bot.reset();
 }
}
Copy

Reset bot buy to retry at current price:

tick = (i, bot, utils) => {
 ...
 if(bot.noPositionMinutes(5)){
    bot.resetDCA();
 }
}
Copy

Used to temporarily stop the bot from placing any new orders. This method does not close the existing position or cancel any pending orders. This method is useful when the user wants to pause the bot’s activity for any reason.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.pause();
 }
}
Copy

Used to reset the bot to neutral state. This method does not close an existing open position. This method will not cancel all the pending orders. This method is useful when the user wants to stop trading with the bot, or to reset the bot to neutral state to be ready for new trades. User must manage any leftover open position.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.reset();
 }
}
Copy

Used to restart the bot from the current open position without closing it. This method allows the user to continue adding orders to the existing position based on the bot’s strategy. This method is useful when the user wants to adjust the bot’s settings or parameters without exiting the position.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.resetDCA();
 }
}
Copy

Used to set the initial amount of money to invest in a stock. This method requires a number as a parameter, which indicates how much money in dollars to use for the first order. This method is useful when the user wants to control the risk and reward of their strategy.

Example

tick = (i, bot, utils) => {
 bot.setBaseOrder(...)
 ...
}
Copy

Used to set the custom price for the entry order if using setEnterType custom price. This method requires a number as a parameter, which indicates what price to use for placing the entry order. This method is useful when the user wants to enter a position at a specific price that they think is favorable.

Example

tick = (i, bot, utils) => {
 bot.setEnterCustomPrice(...)
 ...
}
Copy

Used to set the type of entry order to use when opening a position. This method requires a string as a parameter, which can be either “ask” or “custom”. An ask order is executed at the current ask price, which is the lowest price that someone is willing to sell at. A custom order is executed at a specified price that the user chooses. This method is useful when the user wants to choose between speed and accuracy for their entry order.

Example

tick = (i, bot, utils) => {
 bot.setEnterType(...)
 ...
}
Copy

setLoss *

Example

tick = (i, bot, utils) => {
bot.setLoss(...)
...
}
Copy

Used to set the maximum deviation of the current market price from the last order price to place a new order. This method requires a number as a parameter, which indicates how much deviation in percentage to allow for placing a new order. This method is useful when the user wants to specify max price deviation regardless of actual price deviation set.

Example

tick = (i, bot, utils) => {
 bot.setMaxPriceDeviation(...)
 ...
}
Copy

Used to set the maximum percentage of the budget to use for trading. This method requires a number as a parameter, which indicates how much percentage of the budget to allocate for trading. This method is useful when the user wants to limit their exposure and risk in the market.

Example

tick = (i, bot, utils) => {
 bot.setMaxUsage(...)
 ...
}
Copy

Used to set the deviation of the current market price from the average entry price to place a new order. This method requires a number as a parameter, which indicates how much deviation in percentage to use for placing a new order.

Example

tick = (i, bot, utils) => {
 bot.setPriceDeviation(...)
 ...
}
Copy

setProfit *

Example

tick = (i, bot, utils) => {
bot.setProfit(...)
...
}
Copy

Used to set the scale factor for increasing the distance between each safety order. This method requires a number as a parameter, which indicates how much to multiply the distance between each safety order by. This method is useful when the user wants to avoid placing safety orders too close or too far from each other.

Example

tick = (i, bot, utils) => {
 bot.setSOStepScale(...)
 ...
}
Copy

Used to set the scale factor for sizing the volume of each safety order. This method requires a number as a parameter, which indicates how much to multiply the volume of each safety order by. This method is useful when the user wants to increase their exposure and potential profit as the market price moves further away from their direction.

Example

tick = (i, bot, utils) => {
 bot.setSOVolumeScale(...)
 ...
}
Copy

Used to set the number of additional orders to place after the base order. This method requires a number as a parameter, which indicates the safety orders position quantity to use for averaging down the entry price. This method is useful when the user wants to reduce the risk of losing money when the market price goes against their direction.

Example

tick = (i, bot, utils) => {
 bot.setSafetyOrder(...)
 ...
}
Copy

Used to activate the bot and begin executing orders based on the bot’s strategy. This method is useful when the user wants to start trading with the bot or resume from bot paused state.

Example

tick = (i, bot, utils) => {
 ...
 if(...){
    bot.start();
 }
}
Copy