Orderbook

private/order_quote

Dry-run pricing helper that estimates the outcome of a prospective order without placing it, returning projected fill price and amount, fees, pre/post initial margin, realized PnL, resulting order status and (where relevant) liquidation price and max tradable amount. All monetary values are returned as decimal strings. The private variant requires account-level authentication.

post/private/order_quote

Request

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

Request body

amountstring decimal required

Order amount in units of the base, as a decimal string (e.g. "1.5") or a JSON number.

clientstring
direction'buy' | 'sell' required
extra_feestring decimal nullable

Optional extra fee per unit of volume, as a decimal string or JSON number. Defaults to zero.

instrument_namestring required

Instrument name

is_atomic_signingboolean
labelstring
limit_pricestring decimal required

Limit price in quote currency, as a decimal string or a JSON number.

max_feestring decimal required

Max fee per unit of volume in quote currency, as a decimal string or a JSON number.

mmpboolean
noncestring required

Nonce.

order_type'limit' | 'market'
reduce_onlyboolean
referral_codestring
reject_post_onlyboolean
reject_timestampinteger
signaturestring required

Ethereum signature of the order.

signature_expiry_secinteger required

Signature expiry (unix seconds).

signerstring required

Owner wallet or session key that signed the order.

subaccount_idinteger required

Subaccount ID

time_in_force'gtc' | 'post_only' | 'fok' | 'ioc'
trigger_pricestring decimal nullable

Trigger price as a decimal string or JSON number; omit for non-trigger orders.

trigger_price_type'mark' | 'index'
trigger_type'stoploss' | 'takeprofit'

Response

Success

estimated_feestring required
estimated_fill_amountstring required
estimated_fill_pricestring required
estimated_order_status'open' | 'filled' | 'rejected' | 'cancelled' | 'expired' | 'untriggered' | 'algo_active' required
estimated_realized_pnlstring required
estimated_realized_pnl_excl_feesstring required
invalid_reasonstring nullable
is_validboolean required
max_amountstring nullable
post_initial_marginstring required
post_liquidation_pricestring nullable
pre_initial_marginstring required
suggested_max_feestring required

Changes

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