RFQ

private/rfq_get_best_quote

Taker-side dry run that evaluates a prospective RFQ (its legs and intended direction) without creating anything. Returns the best available maker quote if one exists. It returns no quote when the best quote breaks the RFQ's max_total_cost or min_total_cost. The response also includes the expected fee, validity, projected liquidation prices, and realized-PnL estimate for taking it.

post/private/rfq_get_best_quote

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/rfq_get_best_quote
  • Auth: none declared

Request body

clientstring
direction'buy' | 'sell'
extra_feestring decimal

Non-negative decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

rfq_idstring uuid nullable

RFQ ID to get best quote for.

If not provided, will return estimates based on mark prices.

subaccount_idinteger required

Response

Success

direction'buy' | 'sell' required
down_liquidation_pricestring decimal nullable required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

estimated_feestring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_realized_pnlstring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_realized_pnl_excl_feesstring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_total_coststring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

filled_pctstring decimal required

Non-negative decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

invalid_reasonstring nullable
is_validboolean required
orderbook_total_coststring decimal nullable required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

post_initial_marginstring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

post_liquidation_pricestring decimal nullable required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

pre_initial_marginstring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

suggested_max_feestring decimal required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

up_liquidation_pricestring decimal nullable required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

Changes

No recorded changes to this operation across all 1 revision of this API.