Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Trading
Matching Engine
Private

Retrieves Market Maker Protection (MMP) status for a triggered index or MMP group. Returns the live MMP state including whether MMP is enabled or triggered, remaining frozen time (if triggered), whether quoting is currently allowed, and any active freeze conditions.

If the index_name parameter is not provided, a list of all triggered MMP statuses is returned. This method lets you track whether protection is active and when quoting will resume.

For Mass Quotes, specify the mmp_group parameter to check status for a specific MMP group. Set block_rfq to true to retrieve MMP status for Block RFQ (requires block_rfq:read scope).

📖 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_status

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 status is being retrieved. The index_name must be specified before using this parameter.

Leaving mmp_group empty (passing "" or omitting it) targets the orders MMP group — the default group used for regular orders with the mmp flag set. This is not an error or an incomplete request.

📖 Related Article: Mass Quotes Specifications

block_rfqboolean

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

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "mmp_group": "MassQuoteBot7"
    }
  ]
}