private/get_broker_trade_requests

Broker Method Provides a list of broker block trade requests including pending approvals, declined trades, and expired trades. timestamp and nonce received in response can be used to approve or reject the pending broker block trade. This method takes no parameters.

Scope: block_trade:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_broker_trade_requests \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7,
  "method": "private/get_broker_trade_requests",
  "params": {}
}
'

200

{
  "jsonrpc": "2.0",
  "id": 7,
  "result": [
    {
      "timestamp": 1742824052547,
      "state": "activated",
      "trades": [
        {
          "amount": 100000,
          "direction": "buy",
          "price": 87516.83,
          "instrument_name": "BTC-PERPETUAL"
        }
      ],
      "maker": {
        "state": "initial",
        "client_id": 1,
        "user_id": "***009",
        "client_name": "Test Client",
        "client_link_name": "Test Client 2",
        "client_link_id": 2
      },
      "taker": {
        "state": "initial",
        "client_id": 1,
        "user_id": "***008",
        "client_name": "Test Client",
        "client_link_name": "Test Client 1",
        "client_link_id": 1
      },
      "nonce": "3WqPoAsmde9aXCSEBVUmi2XxGkgA"
    },
    {
      "timestamp": 1742824052538,
      "state": "activated",
      "trades": [
        {
          "amount": 100000,
          "direction": "buy",
          "price": 87516.83,
          "instrument_name": "BTC-PERPETUAL"
        }
      ],
      "maker": {
        "state": "approved",
        "client_id": 1,
        "user_id": "***009",
        "client_name": "Test Client",
        "client_link_name": "Test Client 2",
        "client_link_id": 2
      },
      "taker": {
        "state": "initial",
        "client_id": 1,
        "user_id": "***008",
        "client_name": "Test Client",
        "client_link_name": "Test Client 1",
        "client_link_id": 1
      },
      "nonce": "29rKkuD3NSBPet4njrpNWEuHBm9s"
    }
  ]
}

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. timestamp · integer

Timestamp of the broker block trade request (milliseconds since the UNIX epoch).

result. state · string

State of the broker block trade request.

result. trades · object[]

Hide child attributes

result.trades. amount · number

Trade amount.

result.trades. direction · string

Trade direction (buy or sell).

result.trades. price · number

Trade price.

result.trades. instrument_name · string

Name of the traded instrument.

result. maker · object

Hide child attributes

result.maker. state · string

State of the request from the maker side: initial, approved, or rejected.

result.maker. client_id · integer

ID of a client; available to broker. Represents a group of users under a common name.

result.maker. user_id · string

Obscured user id of the maker.

result.maker. client_name · string

Name of the client; available to broker.

result.maker. client_link_name · string

Name of the linked user within the client; available to broker.

result.maker. client_link_id · integer

ID assigned to a single user in a client; available to broker.

result. taker · object

Hide child attributes

result.taker. state · string

State of the request from the taker side: initial, approved, or rejected.

result.taker. client_id · integer

ID of a client; available to broker. Represents a group of users under a common name.

result.taker. user_id · string

Obscured user id of the taker.

result.taker. client_name · string

Name of the client; available to broker.

result.taker. client_link_name · string

Name of the linked user within the client; available to broker.

result.taker. client_link_id · integer

ID assigned to a single user in a client; available to broker.

result. nonce · string

Nonce for approving or rejecting the broker block trade request.

id · integer

The id that was sent in the request