Create equity monitor .

POST

Create an equity monitor on an individual account.

Request

/equity-monitors

Body

{
    "account_id": 1,
    "type": "protect_value",
    "value": 12000,
    "action": "alert_disable_copiers_close_trades"
}

Response

{
    "result": "success",
    "status": 200,
    "data": {
        "id": 41,
        "created_at": "2023-10-18T13:21:39Z",
        "updated_at": "2023-10-18T13:21:39Z",
        "account_id": 1,
        "status": "active",
        "type": "protect_value",
        "value": 12000,
        "action": "alert_disable_copiers_close_trades"
    }
}

Attributes

Field Required Accepted Description
account_id yes integer Account ID
type yes string A valid equity monitor type. See type below
value yes double A value for the equity monitor type
action yes string A valid equity monitor action. See action below

type

Value Description
target_value Equity monitor will be triggered once this equity value is met, used when you want to trigger ABOVE your current equity.
target_percentage Equity monitor will be triggered once your current equity percentage is ABOVE this value.
protect_value Equity monitor will be triggered once this equity value is met, used when you want to trigger BELOW your current equity.
protect_percentage Equity monitor will be triggered once your current equity percentage is BELOW this value.

action

Value Description
alert The equity monitor will send an alert once triggered.
alert_disable_copiers The equity monitor will send an alert and disable any of the account's trade copiers when triggered.
alert_disable_copiers_close_trades The equity monitor will send an alert, disable any of the account's trade copiers and close all open trades when triggered.

< Equity Monitors Introduction

Update equity monitor >

Stay in the loop..

Sign up to our newsletter to keep up-to-date.