Sign in

v2

latestOpenAPI 3.0.02026-07-311824171.4 MB
Trading
Matching Engine
Private

Retrieves Market Maker Protection (MMP) configuration for an index. Returns all currently active MMP parameters for the selected index, including the interval, frozen_time, quantity/delta/vega limits, and max_quote_quantity.

If the index_name parameter is not provided, a list of all MMP configurations is returned. An empty list means no MMP configuration exists. This method is useful for verifying your configuration or confirming applied updates.

For Mass Quotes, specify the mmp_group parameter to retrieve configuration for a specific MMP group. If no group is provided, returns configuration for regular orders. Set block_rfq to true to retrieve MMP configuration for Block RFQ (requires block_rfq:read scope).

Each entry in the response includes an id field (integer) that uniquely identifies the MMP group. This integer ID is the programmatic identifier for the group and can be used to reference it in contexts where the string mmp_group name is not accepted. Entries that have no mmp_group name in the response correspond to the orders MMP group (the default group).

📖 Related Article: Market Maker Protection API Configuration

Scope: trade:read or block_rfq:read (when block_rfq = true)

Try in API console

get/private/get_mmp_config

Query parameters

index_name'btc_usd' | 'eth_usd' | 'btc_usdc' | 'eth_usdc' | 'ada_usdc' | 'algo_usdc' | 'avax_usdc' | 'bch_usdc' | 'bnb_usdc' | 'doge_usdc' | 'dot_usdc' | 'hype_usdc' | 'link_usdc' | 'ltc_usdc' | 'near_usdc' | 'paxg_usdc' | 'shib_usdc' | 'sol_usdc' | 'ton_usdc' | 'trx_usdc' | 'trump_usdc' | 'uni_usdc' | 'xrp_usdc' | 'usde_usdc' | 'buidl_usdc' | 'btcdvol_usdc' | 'ethdvol_usdc' | 'btc_usdt' | 'eth_usdt' | 'all'

Index identifier of derivative instrument on the platform

Index identifier of derivative instrument on the platform; skipping this parameter will return all configurations

mmp_groupstring
Example:MassQuoteBot7

Specifies the MMP group for which the configuration is being retrieved. MMP groups are used for Mass Quotes. If MMP group is not provided, the method returns the configuration for the MMP settings for regular orders. The index_name must be specified before using this parameter.

Note: Leaving mmp_group empty is explicitly allowed and is the correct way to retrieve configuration for the orders MMP group. It is not an error or an incomplete request — omitting this field intentionally targets the default orders MMP group rather than any named mass quote group.

📖 Related Article: Mass Quotes Specifications

block_rfqboolean

If true, retrieves MMP configuration for Block RFQ. When set, requires block_rfq scope instead of trade scope. Block RFQ MMP settings are completely separate from normal order/quote MMP settings.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request