Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Block Trade
Matching Engine
Private

Checks if a block trade can be executed without actually executing it. Use this method to verify that a block trade will succeed before proceeding with the actual execution.

📖 Related Article: Block Trading

Scope: block_trade:read

Try in API console

get/private/simulate_block_trade

Query parameters

role'maker' | 'taker'

Trade role of the user: maker or taker

Describes if user wants to be maker or taker of trades

instrument_namestring

Unique instrument identifier

pricenumber

Price for trade

amountnumber

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

direction'buy' | 'sell'

Direction: buy, or sell

List of trades for block trade

[
  {
    "instrument_name": "BTC-PERPETUAL"
  }
]

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

resultboolean required

true if block trade can be executed, false otherwise