Skip to main content
POST
Place demo limit order (market-if-touched)

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"60758fd2-674a-4d4f-86dc-7d5792a4c2db"

Body

application/json
InstrumentID
integer<int32>

The unique identifier of the financial instrument.

IsBuy
boolean

Indicates whether the order will open a long (true) or short (false) position.

Leverage
integer<int32>

The leverage ratio for the order.

Amount
number<double> | null

The amount of the trade in the account currency [USD]. Required if AmountInUnits is not provided.

AmountInUnits
number<double> | null

The number of units of the asset. Required if Amount is not provided. For most assets this can be a fractional number. Note that for Future Contracts this number should indicate the number of underlying units, and not the number of contracts, according to the formula: AmountInUnits = contract multiplier * number of contracts.

StopLossRate
number<double>

The stop-loss trigger price at which the position will generate a Market Order to close (after it was opened). StopLoss trigger price must be worse than current price.

TakeProfitRate
number<double>

The take-profit trigger price at which the position will generate a Market Order to close (after it has opened). TakeProfit trigger price must be better than the current price.

Rate
number<double>

The trigger price at which a Market order to open the position will be sent for execution. The trigger price must be better than the current price. This means that the trigger price must be lower than current price for Long positions, and higher than current price for Short positions.

IsTslEnabled
boolean | null

Indicates if a trailing stop loss (TSL) is enabled. This means that the stoploss rate indicated will get updated automatically whenever the asset price increases (for long positions) or decreases (for short position) effectively keeping the stoploss in a constant gap from the best price achieved so far.

IsDiscounted
boolean | null

SHOULD NOT BE EXTERNALZIED

IsNoStopLoss
boolean | null

Indicates if stop-loss is disabled.

IsNoTakeProfit
boolean | null

Indicates if take-profit is disabled.

CID
integer<int32>

SHOULD NOT BE EXTERNALIZED.

Response

Order submitted successfully. The response includes a confirmation token and the created orderId. A 200 indicates submission succeeded, not that the order was created successfully, triggered, or executed.

token
string<uuid>
required

A confirmation token indicating the order creation.

orderId
integer<int64>
required

The unique identifier of the created order.