Skip to navigation

Admin Alert Signal List

View as Markdown

List all admin alert signals.

Available to: All authenticated users (own admin alert signals); organization administrators (signals on accounts in their organization)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieves all entities of AdminAlertSignal type.

Do not poll this endpoint on a schedule. You will eventually hit the rate limit and the operation will fail. Instead, use a WebSocket to receive events in real time. See User Synchronization.

Auto-liquidation triggers. When an account is auto-liquidated or placed in liquidate-only mode, the admin alert signal’s meta field carries an autoLiqTriggers array: a machine-readable list of every risk limit that fired. Read it to react to a liquidation in code, rather than parsing the alert’s free-text message.

meta is a stringified JSON object, so you parse it to reach the array. On the wire, the signal looks like this:

{ "meta": "{\"autoLiqTriggers\":[\"dailyLoss\",\"trailingDrawdown\"]}" }

After you parse meta, the array looks like this:

{ "autoLiqTriggers": ["dailyLoss", "trailingDrawdown"] }

The array lists every limit that fired, not just the first one, and its order means nothing. Check whether a value is in the array rather than where it sits. If an account trips both its daily loss limit and its trailing max drawdown at once, both appear. When no auto-liquidation limit fires, the signal has no meta field.

ValueLimit that fired
marginPercentMargin percentage auto-liquidation limit
dailyLossPercentDaily loss percentage auto-liquidation limit
dailyLossDollar-value daily loss auto-liquidation limit
trailingDrawdownTrailing max drawdown, including the end-of-day drawdown check
dailyProfitDaily profit auto-liquidation limit
weeklyProfitWeekly profit auto-liquidation limit
weeklyLossWeekly loss auto-liquidation limit
steppedCooldownNon-terminal cooldown floor in a stepped-down drawdown ladder
killFloorTerminal kill floor in a stepped-down drawdown ladder

Match these values exactly as shown. New risk limits can be added over time, so new values may show up in the array.

autoLiqTriggers and the alert’s free-text reason serve different purposes and won’t always agree. The free text names a single cause for a person to read. The array lists every limit that fired, for your integration to act on. Key your logic off the array, not the message text.

autoLiqTriggers is additive, so it doesn’t affect existing integrations. It appears only on auto-liquidation alerts (full liquidation or liquidate-only).

Results are scoped to the admin alert signals the caller is permitted to see: their own, and (for organization administrators) signals on accounts in their organization. Signals the caller cannot access are not returned.

Common Failure Scenarios

  • The access token is missing or invalid (returns HTTP 401).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

AdminAlertSignal
timestampdatetime
adminAlertIdlong
textstring<=8192 characters
emailSentboolean
subjectIdlong
idlongOptional
relatedToAccountIdlongOptional
relatedToUserIdlongOptional
ownedByAdminIdlongOptional
Owned By...
completeddatetimeOptional
claimedAtdatetimeOptional