Custom Trade Bot API
Custom bots information and maintainces
All the custom bot endpoints require a signature
Generic
Get all custom bots
Returns:
List of `BaseCustomBot` objects
Example URL:
http://127.0.0.1:8050/AllCustomBotsGet custom bot
Required input:
botGuid : the guid of the bot.
Returns:
`BaseCustomBot` object of the bot.
Example URL:
http://127.0.0.1:8050/GetCustomBot?botGuid=fa6158c1-7a35-4688-91a4-ed0f94a4532bNew custom bot
Required input:
botType : string of 'EnumCustomBotType'
botName : string
accountGuid : guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Activate custom bot
Required input:
botGuid : guid of the bot
extra : boolean. Only relevant for the Crypto Index Box. When true, excessive balance will be reallocate.
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Deactivate custom bot
Required input:
botGuid : guid of the bot
extra : boolean. Relevant for the Flash Crash, Market Making, & Order bot. When true, all open orders will be canceled.
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Remove custom bot
Required input:
botGuid : guid of the bot
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Backtest custom bot
Required input:
botGuid : guid of the bot
minutesToTest : minutes to test
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Backtest custom bot specific dates
Required input:
startUnix : start unix time in seconds
endUnix : end unix time in seconds
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Backtest custom bot specific markets
This endpoint will clone the bot, adjust the market, run a backtest and destroy the bot. Use this to backtest on multiple markets without triggering the market tracking. Required input:
botGuid : guid of the bot
minutesToTest : minutes to test
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Clear custom bot
Required input:
botGuid : guid of the bot
Returns:
`BaseCustomBot` object of the bot.
Example URL:
Clone custom bot
Required input:
botGuid : guid of the bot
botName : name of the new bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
leverage : the leverage of the bot
Returns:
`TradeBot` object of the bot.
Example URL:
Clone custom bot simple
Required input:
botGuid : guid of the bot
botName : name of the new bot
accountGuid : the guid of the account
Returns:
`TradeBot` object of the bot.
Example URL:
Setup
Setup Accumulation Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
stopTypeValue : number
randomOrderSizeX : number
randomOrderSizeY : number
randomOrderTimeX : number
randomOrderTimeY : number
triggerValue : number
triggerWhenHigher : bool
triggerOnPrice : number
stopType : string of 'EnumAccumulationBotStopType'
direction : string of 'EnumOrderType'
Returns:
`AccumulationBot` object of the bot.
Example URL:
Setup Crypto Index Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
templateGuid : string of the template guid to execute
baseCoin : string
totalIndexValue : number
individualGrowth : boolean
allocateProfits : boolean
index : list of 'CryptoIndexBotIndexSaveObject'
Returns:
`CryptoIndexBot` object of the bot.
Example URL:
Setup Email Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
templateGuid : string of the template guid to execute
fee : number
leverage : number
tradeAmount : number
tradeAmountType : string of "EnumBotTradeAmount"
stopLoss : number
minChangeToBuy : number
minChangeToSell : number
emails : list of 'EmailBotAction' objects
Returns:
`EmailBot` object of the bot.
Example URL:
Setup Flash Crash Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
fee : number
basePrice : number
priceSpreadType : string of 'EnumFlashSpreadOptions'
priceSpread : number
percentageBoost : number
minPercentage : number
maxPercentage : number
amountType : number
amountSpread : string of 'EnumCurrencyType'
sellAmount : number
buyAmount : number
refillDelay : number
fttEnabled : boolean
fttOffset : number
fttRange : number
fttTimeout : number
safetyTriggerLevel : number
safetyEnabled : boolean
safetyMoveInOut : boolean
Returns:
`FlashCrashBot` object of the bot.
Example URL:
Setup Intellibot Alice
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
leverage : number
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
fee : number
tradeAmount : number
tradeAmountType : string of "EnumBotTradeAmount"
templateGuid : string of the template guid to execute
Returns:
`BaseCustomBot`` object of the bot.
Example URL:
Setup InterExchange Arbitrage Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
accountGuid2 : the guid of the second account
primaryCoin2 : primary coin of the seconds market.
secondaryCoin2 : secondary coin of the seconds market.
tradeAmount : number
triggerLevel : number
templateGuid : string of the template guid to execute
maxAmount : number
maxTrades : number
Returns:
'InterExchangeArbitrageBot' object of the bot.
Example URL:
Setup MadHatter Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
fee : number
leverage: number
tradeAmount : number
useTwoSignals : boolean
interval : number
disableAfterStopLoss : boolean
includeIncompleteInterval : boolean
templateGuid: string
mappedBuySignal: enumFundsPosition
mappedSellSignal: enumFundsPosition
mappedSellSignal: enumBotTradeAmount
Returns:
`MadHatterBot`` object of the bot.
Example URL:
Setup Market Making Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName: the contract name of the market.
fee : number
leverage: number
templateGuid: the guid of the template used by the bot
stopLossGuid: the template used by stop loss orders.
leverageStartSide: enumFundsPosition
slots: MarketMakingBotSlot
Returns:
`MarketMarkingBot`` object of the bot.
Example URL:
Setup Order Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
Returns:
`OrderBot`` object of the bot.
Example URL:
Setup PingPong Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
fee : number
tradeAmount : number
tradeAmountType : string of "EnumBotTradeAmount"
templateGuid : string of the template guid to execute
leverage : number
Returns:
`BaseCustomBot`` object of the bot.
Example URL:
Setup Scalping Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
leverage : number
tradeAmountType : string of "EnumBotTradeAmount"
tradeAmount : number
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
fee : number
targetProc : number
safetyThreshold : number
Returns:
`ScalperBot`` object of the bot.
Example URL:
Setup Script Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
templateGuid : string
leverage : number
position : primary or secondary currency for spot. long, short or noposition for margin/leverage
fee : number
tradeAmount : number
scriptId : string
Returns:
`ScriptBot`` object of the bot.
Example URL:
Setup Zone Recovery Bot
Required input:
botName : new name of the bot
botGuid : guid of the bot
accountGuid : the guid of the account
primaryCoin : primary coin of the market.
secondaryCoin : secondary coin of the market.
contractName : contract name of the market (optional)
leverage : number
tradeAmount : number,
maxTradeAmount : number,
factorShort : number,
factorLong : number,
targetProfit : number,
zone : number,
Returns:
`ZoneRecoveryBot`` object of the bot.
Example URL:
Accumulation Bot Specific
Flip Accumulation Bot
Required input:
botGuid : guid of the bot
Returns:
Boolean
Example URL:
Crypto Index Bot Specific
Add Index
Required input:
index : JSON string of "CryptoIndexBotIndex"
raiseBalance : boolean
relocateBalance : boolean
Returns:
`CryptoIndexBot`` object of the bot.
Example URL:
Remove Index
Required input:
index : string of coin
lowerBalance : boolean
Returns:
`CryptoIndexBot`` object of the bot.
Example URL:
Flash Crash Bot Specific
Live Order Edit Flash Crash Bot
Required input:
botGuid : guid of the bot
isBuyOrder : true for buy order, false for sell order
addOrder : true to add a order, false to remove a order
Returns:
`FlashCrashBot`` object of the bot.
Example URL:
Quick Start
Required input:
botGuid : guid of the bot. Not required for QuickStartAllFlashCrashBots
Returns:
`FlashCrashBot`` object of the bot.
Example URL:
MadHatter Bot Specific
Set Indicator Parameter
Required input:
botGuid : guid of the bot
type : string of 'EnumMadHatterIndicators'
fieldNo : the index value of the property
value : the new value of the property.
Returns:
`MadHatterBot`` object of the bot.
Example URL:
Set Safety Parameter
Required input:
botGuid : guid of the bot
type : string of 'EnumMadHatterSafeties'
value : the new value of the property.
Returns:
`MadHatterBot`` object of the bot.
Example URL:
Order Bot Specific
Add Order
Required input:
botGuid : guid of the bot
dependsOn : order id of other pre order
dependsOnNotExecuted : order id of other pre order
amount : number
price : number
orderTemplate :string of the template guid to execute
orderType : string of 'EnumOrderType'
triggerPrice : number (default 0)
triggerType : the new value of the property.
Returns:
`OrderBot`` object of the bot.
Example URL:
Edit Order
Required input:
botGuid : guid of the bot
orderGuid : order id of the order.
dependsOn : order id of other pre order
dependsOnNotExecuted : order id of other pre order
amount : number
price : number
orderTemplate :string of the template guid to execute
orderType : string of 'EnumOrderType'
triggerPrice : number (default 0)
triggerType : the new value of the property.
Returns:
`OrderBot`` object of the bot.
Example URL:
Remove Order
Required input:
botGuid : guid of the bot
orderGuid : order id of the order.
Returns:
`OrderBot`` object of the bot.
Example URL:
Remove All Orders
Required input:
botGuid : guid of the bot
Returns:
`OrderBot`` object of the bot.
Example URL:
Reset Order
Required input:
botGuid : guid of the bot
orderGuid : order id of the order.
Returns:
`OrderBot`` object of the bot.
Example URL:
Last updated
Was this helpful?