Advanced Order API
Execute stop, take profit or trailing stop orders on every exchange
All the trade endpoints require a signature
Get Advanced Orders
Required input:
Returns:
object with the guid as key and `AdvancedOrderBase` as value.
Example URL:
Activate Advanced Order
Required input:
guid : the guid of the advanced order
Returns:
`AdvancedOrderBase`
Example URL:
Deactivate Advanced Order
Required input:
guid : the guid of the advanced order
Returns:
`AdvancedOrderBase`
Example URL:
Remove Advanced Order
Required input:
guid : the guid of the advanced order
Returns:
boolean
Example URL:
Add Stop Order
Required input:
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
triggerPrice : the stop price
executionPrice : the price on which to place the order when the stop has triggered
executingTemplateGuid : the template guid which is used to place the order once the stop has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`StopTakeProfitOrder`
Example URL:
Setup Stop Order
Required input:
guid : the guid of the advanced order
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
triggerPrice : the stop price
executionPrice : the price on which to place the order when the stop has triggered
executingTemplateGuid : the template guid which is used to place the order once the stop has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`StopTakeProfitOrder`
Example URL:
Add Take Profit Order
Required input:
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
triggerPrice : the take profit price
executionPrice : the price on which to place the order when the take profit has triggered
executingTemplateGuid : the template guid which is used to place the order once the take profit has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`StopTakeProfitOrder`
Example URL:
Setup Take Profit Order
Required input:
guid : the guid of the advanced order
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
triggerPrice : the take profit price
executionPrice : the price on which to place the order when the take profit has triggered
executingTemplateGuid : the template guid which is used to place the order once the take profit has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`StopTakeProfitOrder`
Example URL:
Add Trailing Stop
Required input:
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
trailingStopPercentage : the trailing stop percentage
executingTemplateGuid : the template guid which is used to place the order once the take profit has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`TrailingStop`
Example URL:
Setup Take Profit Order
Required input:
guid : the guid of the advanced order
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 order
name : the name of the advanced order
orderDirection : string of `EnumOrderType` or string of `EnumFundsPosition`
amount : number
trailingStopPercentage : the trailing stop percentage
executingTemplateGuid : the template guid which is used to place the order once the take profit has triggered.
activate : boolean
startOrderOnActivation : boolean. When true a order will be placed to get into the position.
startOrderPrice : the price on which to place the start order.
startTemplateGuid : the template guid which is used to place the start order
Returns:
`TrailingStop`
Example URL:
Last updated
Was this helpful?