private/get_block_trade_requests

Provides a list of block trade requests including pending approvals, declined trades, and expired trades. timestamp and nonce received in response can be used with private/approve_block_trade or private/reject_block_trade to approve or reject the pending block trade.

To use the block trade approval feature, an additional API key setting feature called enabled_features: block_trade_approval is required. This key has to be given to the broker/registered partner who performs the trades on behalf of the user for the feature to be active. If the user wants to approve the trade, they must approve it from a different API key that doesn’t have this feature enabled.

Only broker clients can use broker_code to query for their broker block trade requests.

📖 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/get_block_trade_requests \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/get_block_trade_requests",
  "params": {
    "broker_code": "jpqYKgg1"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "timestamp": 1742824052538,
      "state": {
        "timestamp": 1742824052539,
        "value": "initial"
      },
      "username": "Trader",
      "user_id": 8,
      "role": "taker",
      "trades": [
        {
          "amount": 100000,
          "direction": "buy",
          "price": 87516.83,
          "instrument_name": "BTC-PERPETUAL"
        }
      ],
      "broker_code": "jpqYKgg1",
      "broker_name": "Test Broker",
      "counterparty_state": {
        "timestamp": 1742824052538,
        "value": "approved"
      },
      "nonce": "29rKkuD3NSBPet4njrpNWEuHBm9s"
    }
  ]
}

Query Parameters

broker_code · string

Broker code to filter block trade requests. Only broker clients can use broker_code to query for their executed broker block trades.

Example:

"jpqYKgg1"

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. nonce · string · required

Nonce that can be used to approve or reject pending block trade.

Example:

"bF1_gfgcsd"

result. timestamp · integer · required

Timestamp that can be used to approve or reject pending block trade.

result. trades · array · required

result. app_name · string · required

The name of the application that executed the block trade on behalf of the user (optional).

Example:

"Example Application"

result. role · enum<string> · required

Trade role of the user: maker or taker

Available options: maker, taker

result. user_id · integer · required

Unique user identifier

Example:

57874

result. state · object · required

State of the pending block trade for current user.

Hide child attributes

result.state. value · enum<string> · required

State value.

Available options: initial, accepted, rejected, executed

result.state. timestamp · integer · required

State timestamp.

result. username · string

Username of the user who initiated the block trade.

Example:

"Trader"

result. broker_code · string

Broker code associated with the broker block trade.

Example:

"jpqYKgg1"

result. broker_name · string

Name of the broker associated with the block trade.

Example:

"Test Broker"

result. counterparty_state · object

State of the pending block trade for the other party (optional).

Hide child attributes

result.counterparty_state. value · enum<string> · required

State value.

Available options: initial, accepted, rejected, executed

result.counterparty_state. timestamp · integer · required

State timestamp.

result. combo_id · string

Combo instrument identifier

Example:

"BTC-CS-27JUN25-80000_85000"

id · integer

The id that was sent in the request