Trade Bot API

Bot information and maintainces

All the trade bot endpoints require a signature

Get all Trade Bots

Returns:

List of `TradeBot` objects.

Example URL:

http://127.0.0.1:8050/AllTradeBots

Backtest Trade Bot

Required input:

  • botGuid : the guid of the bot.

  • startUnix : the unix start time in seconds

  • endUnix : the unix start time in seconds

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/BackTestTradeBot?botGuid=29a242a9-ac4b-4d55-bd16-7e7fcf1084d7&startUnix=1528111773&endUnix=1528118973

Setup trade amount (spot)

Required input:

  • botGuid : the guid of the bot.

  • coinPosition : string of 'EnumCoinsPosition'

  • tradeAmount : number

  • lastBuyPrice : number

  • lastSellPrice : number

  • buyTemplateId : string

  • sellTemplateId : string

  • highSpeedEnabled : boolean

  • allIn : boolean

  • orderTimeout : number

  • templateTimeout : number

  • maxTradeAmount : boolean

  • limitOrderType : number

  • useHiddenOrders : boolean

  • fee : number

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupSpotBotTradeAmount?botGuid=1b180c86-f737-4e14-b08a-1db215f6cbff&coinPosition=Sold&tradeAmount=0.8&lastBuyPrice=123&lastSellPrice=234&buyTemplateId=buyTemplateId&sellTemplateId=sellTemplateId&highSpeedEnabled=True&allIn=False&orderTimeout=99&templateTimeout=123&maxTradeAmount=True&limitOrderType=PlaceOnFirstOrder&useHiddenOrders=True&fee=0.234

Setup trade amount (margin/leverage)

Required input:

  • botGuid : the guid of the bot.

  • fundsPosition : string of 'EnumFundsPosition'

  • tradeAmount : number

  • lastLongPrice : number

  • lastShortPrice : number

  • enterTemplateId : string

  • exitTemplateId : string

  • highSpeedEnabled : boolean

  • allIn : boolean

  • orderTimeout : number

  • templateTimeout : number

  • maxTradeAmount : boolean

  • limitOrderType : number

  • useHiddenOrders : boolean

  • fee : number

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupLeverageBotTradeAmount?botGuid=1d2fa841-925e-4ffc-9595-b11b378bca83&fundsPosition=Long&tradeAmount=2&lastLongPrice=123&lastShortPrice=234&enterTemplateId=enterTemplateGuid&exitTemplateId=exitTemplateGuid&highSpeedEnabled=True&allIn=False&orderTimeout=99&templateTimeout=123&maxTradeAmount=True&limitOrderType=PlaceOnFirstOrder&useHiddenOrders=True&fee=0.234

Add indicator

Required input:

  • botGuid : the guid of the bot.

  • indicatorType : string of 'EnumIndicator'

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/AddIndicator?botGuid=feba7016-8b81-4e6d-9ad3-7485043ff613&indicatorType=Aroon

Add insurance

Required input:

  • botGuid : the guid of the bot.

  • insuranceType : string of 'EnumInsurance'

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/AddInsurance?botGuid=0905204b-742f-428c-877c-7fc4dced195a&insuranceType=AbsolutePriceChange

Add safety

Required input:

  • botGuid : the guid of the bot.

  • safetyType : string of 'EnumSafety'

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/AddSafety?botGuid=072b4b8e-f2b4-453c-8327-9721666d0985&safetyType=StopLossDynamic

Setup Trade Bot

Required input:

  • botGuid : the 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,

  • groupId : string

  • useConsensus : boolean

  • copyMarketToElements : boolean

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupTradeBot?botGuid=dd386251-43fd-4568-baa0-e8ea02dd3a06&botName=RenamedBot&accountGuid=43b1c5f8-31d4-45c0-9163-81b1443146b4&primaryCoin=LTC&secondaryCoin=BTC&contractName=&leverage=4&groupId=TestGroupId&useConsensus=False&copyMarketToElements=True

Setup Trade Bot indicator

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • priceSourceName : string of 'EnumPriceSource'

  • primaryCoin : primary coin of the market.

  • secondaryCoin : secondary coin of the market.

  • contractName : contract name of the market (optional)

  • delay : number,

  • priceChartType : string of 'EnumPriceChartType'

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupTradeBotIndicator?botGuid=8f5f227c-d478-4458-9ae5-bb4264e816ff&elementGuid=bfca868c-8597-461c-a06e-19a294a720b8&priceSourceName=Bittrex&primaryCoin=ETH&secondaryCoin=BTC&contractName=&interval=60&delay=60&priceChartType=HeikinAshi

Setup Trade Bot indicator signals (spot)

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • useBuySignal : boolean

  • useSellSignal : boolean

  • reverseSignals : boolean

  • standAlone : boolean

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupTradeBotIndicatorSpotSignals?botGuid=ea2ebcfe-c023-47f5-81be-712674b5bf2f&elementGuid=4f2a6fe5-20e6-4496-a920-404b5d25c4c4&useBuySignal=False&useSellSignal=False&reverseSignals=True&standAlone=True

Setup Trade Bot indicator signals (leverage)

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • useLongSignals : boolean

  • useNoPositionSignals : boolean

  • useShortSignals : boolean

  • reverseSignals : boolean

  • standAlone : boolean

mappedLongSignal: string of EnumFundsPosition mappedShortSignal: string of EnumFundsPosition Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupTradeBotIndicatorLeverageSignals?botGuid=f72bda0b-88cf-4e1e-9b41-6823e0c38683&elementGuid=6ed3da80-4b14-4fd6-a3fa-9b8a99a2fe1c&useLongSignals=False&useNoPositionSignals=False&useShortSignals=False&reverseSignals=True&standAlone=True&mappedLongSignal=Short&mappedShortSignal=Long

Setup Trade Bot safety

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • priceSourceName : string of 'EnumPriceSource'

  • primaryCoin : primary coin of the market.

  • secondaryCoin : secondary coin of the market.

  • contractName : contract name of the market (optional)

  • mappedBuySignal : string of 'EnumFundsPosition'

  • mappedSellSignal : string of 'EnumFundsPosition'

  • validPositionSignal: string of `EnumSafetyPositionSignal`

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/SetupTradeBotSafety?botGuid=5a5e2cbc-6964-4953-aa7c-83ff22030abf&elementGuid=61f68eb4-e198-46e8-91a2-226fa22e4536&priceSourceName=Bittrex&primaryCoin=ETH&secondaryCoin=BTC&contractName=&mappedBuySignal=Short&mappedSellSignal=Long&validPositionSignal=Long

Clean Trade Bot

Required input:

  • botGuid : the guid of the bot.

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/CleanTradeBot?botGuid=32774185-dcdc-48da-b783-4bdc90600c75

Clone indicator

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element to clone.

  • toBotGuid : the guid of the bot to which the element is cloned

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/CloneIndicator?botGuid=d896e230-dd69-4984-bd55-59d3e3cae7e3&elementGuid=1983681d-d188-4210-b8e8-f6f6bd19ee3e&toBotGuid=d896e230-dd69-4984-bd55-59d3e3cae7e3

Clone insurance

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element to clone.

  • toBotGuid : the guid of the bot to which the element is cloned

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/CloneInsurance?botGuid=38831011-0779-4615-ae01-d0117e7dbb2d&elementGuid=1d9d8dfe-6e51-4387-84be-a6591ae38c54&toBotGuid=38831011-0779-4615-ae01-d0117e7dbb2d

Clone safety

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element to clone.

  • toBotGuid : the guid of the bot to which the element is cloned

Returns:

`TradeBot` object.

Example URL:

http://127.0.0.1:8050/CloneSafety?botGuid=072b4b8e-f2b4-453c-8327-9721666d0985&elementGuid=3b1a4729-ec3f-4ed4-b50b-a18394c511f7&toBotGuid=072b4b8e-f2b4-453c-8327-9721666d0985

Clone Trade Bot

Required input:

  • botGuid : the guid of the bot.

  • botName : the 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 market.

  • copySafeties : boolean

  • copyIndicators : boolean

  • copyInsurances : boolean

  • copyParameters : boolean

  • copyMarketToElements : boolean

Returns:

`TradeBot` object of the new bot.

Example URL:

http://127.0.0.1:8050/CloneTradeBot?botGuid=ea1d7324-2fb2-4749-baaf-5653b0124605&botName=ClonedBot&accountGuid=55c658c6-aa81-4f08-9e24-e0db446d11cb&primaryCoin=XBT&secondaryCoin=USD&contractName=XBTUSD&leverage=4&copySafeties=True&copyIndicators=True&copyInsurances=True&copyParameters=True&copyMarketToElements=True

Edit Trade Bot indicator setting

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • fieldNo : the index value of the property

  • value : the new value of the property.

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/EditTradeBotIndicatorSetting?botGuid=ddd45404-e153-4047-8156-e0f28b8dd641&elementGuid=47e2ade0-7d11-43cb-964a-643ed923fb2f&fieldNo=0&value=99

Edit Trade Bot insurance setting

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • fieldNo : the index value of the property

  • value : the new value of the property.

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/EditTradeBotInsuranceSetting?botGuid=0905204b-742f-428c-877c-7fc4dced195a&elementGuid=daf8cc25-19ff-4b14-82f3-30da34def1e4&fieldNo=0&value=99

Edit Trade Bot safety setting

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

  • fieldNo : the index value of the property

  • value : the new value of the property.

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/EditTradeBotSafetySetting?botGuid=a2515ebe-44f7-4326-918d-43a4fa7b86fd&elementGuid=321331c2-8465-49f3-a832-33a4dbc192b8&fieldNo=0&value=99

Lock Trade Bot

Required input:

  • botGuid : the guid of the bot.

  • lockBot : boolean

Returns:

Boolean.

Example URL:

http://127.0.0.1:8050/LockTradeBot?botGuid=227f5c17-12e2-4e4e-9173-6e32b2acaab7&lockBot=False
http://127.0.0.1:8050/LockTradeBot?botGuid=227f5c17-12e2-4e4e-9173-6e32b2acaab7&lockBot=True

New Trade Bot

Required input:

  • botName : the 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 market.

  • groupId : the guid of the group (optional)

Returns:

`TradeBot` object of the new bot.

Example URL:

http://127.0.0.1:8050/NewTradeBot?botName=LocalApiBot&accountGuid=55c658c6-aa81-4f08-9e24-e0db446d11cb&primaryCoin=XBT&secondaryCoin=USD&contractName=XBTUSD&leverage=2&groupId=

Remove indicator

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/RemoveIndicator?botGuid=9c7ae522-b8c3-44cf-883b-7edfda520d0b&elementGuid=6e895853-e3c6-41c6-aa1e-04f7673d219c

Remove insurance

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/RemoveInsurance?botGuid=1bf22dad-8598-4755-9428-d0e92fe74716&elementGuid=8fff8c01-2b29-4548-961c-bc3524acf946

Remove safety

Required input:

  • botGuid : the guid of the bot.

  • elementGuid : the guid of the element

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/RemoveSafety?botGuid=66cd1c92-e1b1-4d1f-ab36-9dc73eecc4fb&elementGuid=57d9c0c0-bc77-422c-b34b-9e2bf0f78a4c

Remove Trade Bot

Required input:

  • botGuid : the guid of the bot.

Returns:

Boolean

Example URL:

http://127.0.0.1:8050/RemoveTradeBot?botGuid=072b4b8e-f2b4-453c-8327-9721666d0985

Switch Trade Bot coin positions

Required input:

  • botGuid : the guid of the bot.

  • coinPosition : string of 'EnumCoinsPosition'

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/SwitchTradeBotCoinPositions?botGuid=f6e61295-bf40-40d6-86d0-fd6464422dd9&coinPosition=Sold

Switch Trade Bot funds positions

Required input:

  • botGuid : the guid of the bot.

  • fundsPosition : string of 'EnumFundsPosition'

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/SwitchTradeBotFundsPositions?botGuid=d3d6a700-a09e-4ae7-a107-c6865a88d175&fundsPosition=Short

Switch Trade Bot coin positions with order

Required input:

  • botGuid : the guid of the bot.

  • templateGuid : the guid of the template executed.

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/SwitchTradeBotCoinPositionsWithOrder?botGuid=bd568f21-45a1-44eb-bf73-503ef3e79061&templateGuid=LOCKEDLIMITORDERGUID

Switch Trade Bot funds positions with order

Required input:

  • botGuid : the guid of the bot.

  • fundsPosition : string of 'EnumFundsPosition'

  • templateGuid : the guid of the template executed.

Returns:

`TradeBot` object of the bot.

Example URL:

http://127.0.0.1:8050/SwitchTradeBotFundsPositionsWithOrder?botGuid=fb9c8079-70aa-42cd-a57f-7f1715adacb9&templateGuid=LOCKEDLIMITORDERGUID&fundsPosition=Long