market-maker-protection

Get Market Marker Protection (MMP) by Trading Account ID

Get market maker protection configurations under a trading account id

This endpoint requires authentication. To filter by symbol, additional parameters are required. For detailed instructions, see the Filtering Support section.

get/v2/mmp-configuration

Request

Query parameters

symbolstring

the underlying asset symbol that is configured for MMP checks

Example:BTC

The underlying asset id you filter the configurations against. If symbol is provided, this API will only return the market maker protection configuration for this symbol for this trading account.

tradingAccountIdstring required

unique trading account ID

Example:111000000000001

Id of the trading account

Response

Status OK. This means a command was successfully acknowledged.

tradingAccountIdstring required

unique trading account ID

messagestring required

If there are no market maker protection configurations setup for this trading account or for the provided optional symbol under the same trading account, this field will be returned as "No mmp config setup".

Example response

{
  "tradingAccountId": "111000000000001",
  "message": "No mmp config setup",
  "mmpConfigurations": [
    {
      "underlyingAssetSymbol": "BTC",
      "windowTimeInSeconds": 60,
      "frozenTimeInSeconds": 120,
      "quantityLimit": "100",
      "deltaLimit": "10",
      "isActive": true
    }
  ]
}

Changes

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