Get active status notices
Status notices shown as a banner above the app navigation and listed in full on the public status page. No authentication required.
Severity
Several notices can be active at once. The array is sorted most severe first, then by priority, then newest — so a client renders element [0] as its single banner and never has to sort. The status page renders the whole array.
| Severity | Meaning |
|---|---|
info | Informational, no trading impact (migration, release, maintenance) |
warning | Degraded conditions — trading is discouraged |
critical | Do not open positions — close-only, or trading halted |
priority only breaks ties within one severity. A critical notice always outranks a warning, whatever their priorities.
Fields
message is the one-line banner text. title and description are the longer form used on the status page; title falls back to message when null. effectiveAt is when the notice took effect (its scheduled start, or when it was created) — that is the timestamp to show a user.
Scheduling
Only rows that are active AND inside their window are returned. startsAt in the future or endsAt in the past excludes a row; null on either side means unbounded. The window is evaluated server-side, so a maintenance notice can be scheduled once and left alone.
Dismissing
When dismissible is true, send the returned dismissalKey to POST /platform/v1/user/dismissals and stop rendering that notice for the user (that endpoint does require a session). The key is built server-side (ann:<id>) so the two cannot drift apart, and it fits the 50-character limit that endpoint validates. Incident notices are typically created with dismissible: false so a trader cannot hide a close-only warning.
Colours
backgroundColor and textColor are optional overrides. Leave them null — the normal case — and the client styles from severity, which stays legible in both light and dark mode. Only set them for a deliberate one-off.
curl "https://api.hyperprop.com/platform/v1/announcements"
Related topics
Get account lockout statusGet lockout status for accountGet copy trading status and positionsList all active lockoutsGet active working orders