private/cancel_block_rfq

Taker method

Cancels a Block RFQ using the specified block_rfq_id.

Use private/get_block_rfqs to retrieve Block RFQ information, or private/create_block_rfq to create a new Block RFQ.

📖 Related Article: Deribit Block RFQ API walkthrough

Scope: block_rfq:read_write

Try in API console

cURL

cURL

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

200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "creation_timestamp": 1729855159611,
    "block_rfq_id": 366,
    "expiration_timestamp": 1729855459611,
    "role": "taker",
    "asks": [],
    "bids": [],
    "makers": [],
    "amount": 100000,
    "legs": [
      {
        "ratio": 1,
        "instrument_name": "BTC-1NOV24",
        "direction": "sell"
      },
      {
        "ratio": 1,
        "instrument_name": "BTC-PERPETUAL",
        "direction": "buy"
      }
    ],
    "combo_id": "BTC-FS-1NOV24_PERP",
    "state": "cancelled",
    "label": "example"
  }
}

Query Parameters

block_rfq_id · integer · required

ID of the Block RFQ

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

The timestamp when Block RFQ was created (milliseconds since the Unix epoch)

Example:

1536569522277

result. expiration_timestamp · integer

The timestamp when the Block RFQ will expire (milliseconds since the UNIX epoch)

Example:

1536569522277

result. block_rfq_id · integer

ID of the Block RFQ

result. role · enum<string>

Role of the user in Block RFQ

Available options: taker, maker

result. state · enum<string>

State of the Block RFQ

Available options: open, filled, cancelled, expired

result. taker_rating · string

Rating of the taker

result. makers · string[]

List of targeted Block RFQ makers

result. amount · number

This value multiplied by the ratio of a leg gives trade size on that leg.

result. min_trade_amount · number

Minimum amount for trading

result. asks · object[]

Hide child attributes

result.asks. makers · string[]

Maker of the quote

result.asks. price · number

Price of a quote

result.asks. last_update_timestamp · integer

Timestamp of the last update of the quote (milliseconds since the UNIX epoch)

Example:

1536569522277

result.asks. execution_instruction · enum<string>

Execution instruction of the quote. Default - any_part_of

• "all_or_none (AON)" - The quote can only be filled entirely or not at all, ensuring that its amount matches the amount specified in the Block RFQ. Additionally, 'all_or_none' quotes have priority over 'any_part_of' quotes at the same price level.
• "any_part_of (APO)" - The quote can be filled either partially or fully, with the filled amount potentially being less than the Block RFQ amount.

Available options: any_part_of, all_or_none

result.asks. amount · number

This value multiplied by the ratio of a leg gives trade size on that leg.

result.asks. expires_at · integer

The timestamp when the quote expires (milliseconds since the Unix epoch), equal to the earliest expiry of placed quotes

Example:

1745312540321

result. bids · object[]

Hide child attributes

result.bids. makers · string[]

Maker of the quote

result.bids. price · number

Price of a quote

result.bids. last_update_timestamp · integer

Timestamp of the last update of the quote (milliseconds since the UNIX epoch)

Example:

1536569522277

result.bids. execution_instruction · enum<string>

Execution instruction of the quote. Default - any_part_of

• "all_or_none (AON)" - The quote can only be filled entirely or not at all, ensuring that its amount matches the amount specified in the Block RFQ. Additionally, 'all_or_none' quotes have priority over 'any_part_of' quotes at the same price level.
• "any_part_of (APO)" - The quote can be filled either partially or fully, with the filled amount potentially being less than the Block RFQ amount.

Available options: any_part_of, all_or_none

result.bids. amount · number

This value multiplied by the ratio of a leg gives trade size on that leg.

result.bids. expires_at · integer

The timestamp when the quote expires (milliseconds since the Unix epoch), equal to the earliest expiry of placed quotes

Example:

1745312540321

result. legs · object[]

Hide child attributes

result.legs. ratio · integer

Ratio of amount between legs

result.legs. instrument_name · string

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.legs. direction · enum<string>

Direction: buy, or sell

Available options: buy, sell

result. hedge · object

Hide child attributes

result.hedge. amount · integer

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

result.hedge. instrument_name · string

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.hedge. direction · enum<string>

Direction: buy, or sell

Available options: buy, sell

result.hedge. price · number

Price for a hedge leg

result. combo_id · string

Unique combo identifier

Example:

"BTC-FS-31DEC21-PERP"

result. label · string

User defined label for the Block RFQ (maximum 64 characters)

result. app_name · string

The name of the application that created the Block RFQ on behalf of the user (optional, visible only to taker).

Example:

"Example Application"

result. mark_price · number

The mark price for the instrument

result. disclosed · boolean

Indicates whether the RFQ was created as non-anonymous, meaning taker and maker aliases are visible to counterparties.

result. taker · string

Taker alias. Present only when disclosed is true.

Example:

"TAKER1"

result. index_prices · number[]

A list of index prices for the underlying instrument(s) at the time of trade execution.

result. included_in_taker_rating · boolean

Indicates whether the RFQ is included in the taker's rating calculation. Present only for closed RFQs created by the requesting taker.

result. trades · object[]

Hide child attributes

result.trades. direction · enum<string>

Direction: buy, or sell

Available options: buy, sell

result.trades. price · number

Price in base currency

result.trades. amount · number

Trade amount. For options, linear futures, linear perpetuals and spots the amount is denominated in the underlying base currency coin. The inverse perpetuals and inverse futures are denominated in USD units.

result.trades. maker · string

Alias of the maker (optional)

result.trades. hedge_amount · number

Amount of the hedge leg. For linear futures, linear perpetuals and spots the amount is denominated in the underlying base currency coin. The inverse perpetuals and inverse futures are denominated in USD units.

result. trade_trigger · object

Present only if a trade trigger was placed by the taker and only visible to taker. Only for cases: cancelled (contains the reason for cancellation) and untriggered (contains the information about the trade trigger).

Hide child attributes

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

Trade trigger state: "untriggered" or "cancelled"

Available options: triggered, untriggered, cancelled

result.trade_trigger. price · number · required

Price of the trade trigger

result.trade_trigger. direction · enum<string> · required

Direction of the trade trigger

Available options: buy, sell

result.trade_trigger. cancel_reason · string

Reason for cancellation, present only when state is cancelled

result. trade_allocations · object[]

List of allocations for Block RFQ pre-allocation. Allows to split amount between different (sub)accounts. The taker can also allocate to himself. Visible only to the taker.

Hide child attributes

result.trade_allocations. user_id · integer

User ID to allocate part of the RFQ amount. For brokers the User ID is obstructed.

result.trade_allocations. client_info · object

Client allocation info for brokers.

Hide child attributes

result.trade_allocations.client_info. client_id · integer

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

result.trade_allocations.client_info. client_link_id · integer

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

result.trade_allocations.client_info. name · string

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

result.trade_allocations. amount · number

Amount allocated to this user or client.

id · integer

The id that was sent in the request