private/simulate_block_trade

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

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/simulate_block_trade \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/simulate_block_trade",
  "params": {
    "role": "maker",
    "trades": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "direction": "buy",
        "price": 11624,
        "amount": 40
      },
      {
        "instrument_name": "BTC-9AUG19-10250-P",
        "direction": "buy",
        "amount": 1.2,
        "price": 0.0707
      }
    ]
  }
}
'

200

{
  "jsonrpc": "2.0",
  "result": true
}

Query Parameters

role · enum<string>

Describes if user wants to be maker or taker of trades Trade role of the user: maker or taker

Available options: maker, taker

trades · object[] · required

List of trades for block trade

Hide child attributes

trades. instrument_name · string

Instrument name

Example:

"BTC-PERPETUAL"

trades. price · number

Price for trade

trades. amount · number

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

trades. direction · enum<string>

Direction of trade from the maker perspective

Available options: buy, sell

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · boolean · required

true if block trade can be executed, false otherwise

id · integer

The id that was sent in the request