HomeDocumentationAPI Reference
Log In

Get Mmp Config

Method Name

private/get_mmp_config

Get the current mmp config for a subaccount (optionally filtered by currency)

Parameters

subaccount_id integer required
Subaccount_id for which to get the config
currency string
Currency to get the config for. If not provided, returns all configs for the subaccount

Response

id string or integer required
result array of objects required
result[].currency string required
Currency of this mmp config
result[].is_frozen boolean required
Whether the subaccount is currently frozen
result[].mmp_frozen_time integer required
Time interval in ms setting how long the subaccount is frozen after an mmp trigger, if 0 then a manual reset would be required via private/reset_mmp
result[].mmp_interval integer required
Time interval in ms over which the limits are monotored, if 0 then mmp is disabled
result[].mmp_unfreeze_time integer required
Timestamp in ms after which the subaccount will be unfrozen
result[].subaccount_id integer required
Subaccount_id for which to set the config
result[].mmp_amount_limit string
Maximum total order amount that can be traded within the mmp_interval across all instruments of the provided currency. The amounts are not netted, so a filled bid of 1 and a filled ask of 2 would count as 3.
Default: 0 (no limit)
result[].mmp_delta_limit string
Maximum total delta that can be traded within the mmp_interval across all instruments of the provided currency. This quantity is netted, so a filled order with +1 delta and a filled order with -2 delta would count as -1
Default: 0 (no limit)

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}