Unmanaged Trade Commands

PlaceBuyOrder

Places a (limit) buy order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceBuyOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,MaxBuyAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

PlaceCancelledOrder

Executes the remaining amount of a canceled order.

Syntax: PlaceCancelledOrder(orderId, [ price ])

Returns an new order identifier. Empty if no order is executed.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

orderId

String

True

price

Number

False

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

PlaceExitLongOrder

Places a (limit) exit long order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceExitLongOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,LongAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

PlaceExitPositionOrder

Places exit orders for a specific bot position.

Syntax: PlaceExitPositionOrder([ positionId ], [ price ], [ type ], [ note ], [ timeout ])

Returns an order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

positionId

String

False

Load

price

Number

False

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

timeout

Number

False

Input,Number,SessionGet

PlaceExitShortOrder

Places a (limit) exit short order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceExitShortOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,ShortAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

PlaceGoLongOrder

Places a (limit) go long order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceGoLongOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,MaxBuyAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

PlaceGoShortOrder

Places a (limit) go short order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceGoShortOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,MaxSellAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

PlaceSellOrder

Places a (limit) sell order for the given amount and price. Returns the order identifier (text).

Syntax: PlaceSellOrder(price, amount, [ market ], [ type ], [ note ], [ positionId ], [ timeout ], [ triggerPrice ], [ reduceOnly ], [ hiddenOrder ])

Unique order identifier.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

price

Number

True

GetBuyPrices,GetSellPrices,GetOpenPrices,GetHighPrices,GetLowPrices,GetClosePrices,GetHighLowPrices,GetHighLowClosePrices,GetOpenClosePrices,GetOpenHighLowClosePrices,GetBodyHighPrices,GetBodyLowPrices

amount

Number

True

TradeAmount,Number,Input,MaxSellAmount

market

String

False

InputAccountMarket,InputMarket,InputPriceSourceMarket,PriceMarket

type

Enum

False

MarketOrderType,LimitOrderType,MakerOrCancelOrderType,NoTimeOutOrderType,StopLimitOrderType,StopMarketOrderType,TakeProfitLimitOrderType,TakeProfitMarketOrderType,TrailingStopMarketOrderType

note

String

False

Text,Input,SessionGet,Load

positionId

String

False

Load,NewGuid

timeout

Number

False

Input,Number,SessionGet

triggerPrice

Number

False

Input,Number,SessionGet

reduceOnly

Boolean

False

True,False

hiddenOrder

Boolean

False

True,False

Last updated