v1
latestOpenAPI 3.0.32026-08-04850206.9 KBAlarms
List alarms
The key owner's alarms, newest first, paginated. Filter by status, direction or notification channel.
get/api/v1/alarms
Query parameters
pageinteger nullable
Page number (1-based).
Example:1
Page number (1-based).
per_pageinteger nullable
Rows per page (1–100, default 25).
Example:25
Rows per page (1–100, default 25).
statusstring nullable
Filter by state: active or triggered.
Example:active
Filter by state: active or triggered.
directionstring nullable
Filter by trigger direction: above or below.
Example:above
Filter by trigger direction: above or below.
notificationstring nullable
Filter by delivery channel: email, push or webhook.
Example:email
Filter by delivery channel: email, push or webhook.
Response
Example response
{
"data": [
{
"id": 42,
"name": "BTC six figures",
"coin": {
"slug": "bitcoin",
"symbol": "BTC",
"name": "Bitcoin"
},
"metric": "rate",
"direction": "above",
"target": "100000",
"notification": "email",
"status": "active",
"created_at": "2026-06-21T09:15:00+00:00"
}
],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 3,
"last_page": 1
}
}