Guards and alerts
Alerts and webhooks, the equity guard, prop-firm rules and the news guard.
manage_alerts
Create/list/delete alerts and read fired events. Types: price, indicator, position_event (sl_hit, tp_hit, position_closed, liquidated, protection_lost, ratchet_moved), margin_ratio, funding, liquidation_distance. Alert count is capped per tier (Free 0, Pro 10, Team 50, Enterprise 200). Webhooks: webhook_create {webhook:{url, event_types?}} (https on 443, public host; returns the signing secret once), webhook_list, webhook_delete {webhook_id}, webhook_test {webhook_id}; every alert event on this connection is POSTed signed with X-CC-Signature t=<unix>,v1=hex(HMAC-SHA256(secret, "<t>.<body>")), retried with backoff, and an endpoint that keeps failing is disabled. Available on every tier.
Capability: read · read-only · REST: POST /v1/tools/manage_alerts
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | create | list | delete | events | webhook_create | webhook_list | webhook_delete | webhook_test | yes | — | |
alert_id | string | no | — | |
alert | object | no | — | |
limit | integer | no | — | |
webhook | object | no | — | |
webhook_id | string | no | — |
Example request:
{
"action": "create"
}manage_equity_guard
Per-connection equity guard: when daily drawdown or equity floor is breached, exposure-creating commands are blocked and (optionally) positions are closed with reduce-only markets. Risk-reducing commands are never blocked. dry_run defaults to true (previews the change; pass dry_run:false to persist). Requires the trade capability (Pro and above; simulated connections may trade on every tier).
Changes your exchange account or platform state. It previews by default: pass dry_run: false to execute. Paper mode forces a preview.
Capability: trade · mutating · REST: POST /v1/tools/manage_equity_guard
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | get | set | clear | status | yes | — | |
config | object | no | — | |
dry_run | boolean | yes | true | Default true: validate and preview only. Set false to execute. |
Example request:
{
"action": "get",
"dry_run": true
}manage_prop_firm_rules
Prop-firm style limits. Presets: ftmo, generic, crypto_generic (5% daily / 10% total static, UTC reset). Actions: get/set/clear/status/trade_advice. status reports configured, breached, breach_reason, headroom and max_safe_risk_percent (configured:false when no ruleset is set). dry_run defaults to true (previews the change; pass dry_run:false to persist). Requires the trade capability (Pro and above; simulated connections may trade on every tier).
Changes your exchange account or platform state. It previews by default: pass dry_run: false to execute. Paper mode forces a preview.
Capability: trade · mutating · REST: POST /v1/tools/manage_prop_firm_rules
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | get | set | clear | status | trade_advice | yes | — | |
config | object | no | — | |
proposed_risk_percent | number | no | — | |
dry_run | boolean | yes | true | Default true: validate and preview only. Set false to execute. |
Example request:
{
"action": "get",
"dry_run": true
}manage_news_guard
Blackout window around high-impact events for the configured assets/currencies (e.g. BTC, ETH, USD). Requires the analytics capability (Pro and above).
Capability: analytics · read-only · REST: POST /v1/tools/manage_news_guard
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | get | set | clear | status | yes | — | |
config | object | no | — |
Example request:
{
"action": "get"
}