private/get_block_rfq_quotes

Maker method

Retrieves all open quotes for Block RFQs. When a block_rfq_id is specified, only the open quotes for that particular Block RFQ will be returned. When a label is specified, all quotes with this label are returned. block_rfq_quote_id returns one specific quote.

Use private/add_block_rfq_quote to add quotes, or private/get_block_rfqs to retrieve Block RFQ information.

📖 Related Article: Deribit Block RFQ API walkthrough

Scope: block_rfq:read

Try in API console

cURL

cURL

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

200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "label": "example_quote",
    "amount": 20000,
    "direction": "buy",
    "price": 74600,
    "legs": [
      {
        "direction": "buy",
        "price": 74600,
        "instrument_name": "BTC-15NOV24",
        "ratio": 1
      }
    ],
    "creation_timestamp": 1731076586371,
    "block_rfq_id": 1,
    "replaced": false,
    "filled_amount": 0,
    "last_update_timestamp": 1731076638591,
    "hedge": {
      "amount": 10,
      "direction": "buy",
      "price": 70000,
      "instrument_name": "BTC-PERPETUAL"
    },
    "block_rfq_quote_id": 8,
    "quote_state": "open",
    "execution_instruction": "all_or_none"
  }
}

Query Parameters

block_rfq_id · integer

ID of the Block RFQ

label · string

User defined label for the Block RFQ quote (maximum 64 characters). Used to identify quotes of a selected Block RFQ

block_rfq_quote_id · integer

ID of the Block RFQ quote

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 quote was created (milliseconds since the Unix epoch)

Example:

1536569522277

result. last_update_timestamp · integer

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

Example:

1536569522277

result. block_rfq_id · integer

ID of the Block RFQ

result. block_rfq_quote_id · integer

ID of the Block RFQ quote

result. quote_state · string

State of the quote

result. 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. price · number

Price of a quote

result. amount · number

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

result. direction · enum<string>

Direction of trade from the maker perspective

Available options: buy, sell

result. filled_amount · number

Filled amount of the quote. For perpetual and futures the filled_amount is in USD units, for options - in units or corresponding cryptocurrency contracts, e.g., BTC or ETH.

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.legs. price · number

Price for a leg

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. replaced · boolean

true if the quote was edited, otherwise false.

result. label · string

User defined label for the quote (maximum 64 characters)

result. app_name · string

The name of the application that placed the quote on behalf of the user (optional).

Example:

"Example Application"

result. quote_state_reason · string

Reason of quote cancellation

id · integer

The id that was sent in the request