Skip to navigation

Set market maker protection config

Replaces the account’s market maker protection (MMP) config for a base asset with dated option or perpetual futures markets. An omitted limit becomes 0, disabling that check; at least one limit must be above 0. vega_limit counts only dated option fills, so it cannot be the only limit where there are none. 403 MMP_NOT_ENABLED unless MMP is enabled for the account. Read-only tokens are rejected.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

base_assetstringRequired

Base asset - example: BTC

Request

MMP configuration
frozen_time_msintegerRequired
How long a trip freezes MMP orders, in milliseconds, 0 to 3600000. 0 freezes until a manual reset
interval_msintegerRequired
Sliding window length in milliseconds, 100 to 3600000
delta_limitstringOptional

Trips when the absolute net delta of fills in the window exceeds this, in base asset units. Up to 4 decimal places; 0 or omitted disables the check

protect_block_tradesbooleanOptional

Protects this base asset's block trade legs, RFQ executions included, where the account is the maker: the desk that responds with a quote or offer. Omitting it keeps the stored value (false if never set). Protected block trades share the window with order book fills. A change applies to block trades and offers created afterwards.

size_limitstringOptional

Trips when the sum of fill sizes in the window exceeds this, in base asset units. Up to 4 decimal places; 0 or omitted disables the check

vega_limitstringOptional

Trips when the absolute net vega of fills in the window exceeds this, in USD. Up to 4 decimal places; 0 or omitted disables the check

Response

OK
base_assetstringOptional
Base asset the config applies to, across its dated options and perpetual futures
delta_limitstringOptional

Delta limit in base asset units; 0 = check disabled

frozen_time_msintegerOptional
How long a trip freezes MMP orders, in milliseconds. 0 freezes until a manual reset
frozen_untilintegerOptional

Unix millis the freeze ends. 0 while frozen means until a manual reset; 0 when not frozen

interval_msintegerOptional
Sliding window length in milliseconds. 0 when MMP was removed
is_frozenbooleanOptional
Whether MMP orders on the base asset are frozen
protect_block_tradesbooleanOptional
Whether block trade legs, RFQ executions included, are protected
size_limitstringOptional

Size limit in base asset units; 0 = check disabled

updated_atintegerOptional
Unix milliseconds the config was last written
vega_limitstringOptional

Vega limit in USD; 0 = check disabled

window_deltastringOptional
Net signed delta of fills in the current window, in base asset units
window_sizestringOptional
Sum of fill sizes in the current window, in base asset units
window_vegastringOptional
Net signed vega of fills in the current window, in USD

Errors

400
Bad Request Error
403
Forbidden Error
503
Service Unavailable Error