v1

latestOpenAPI 3.0.32026-08-04850206.9 KB

Alarms

Create an alarm

Creates a TARGET alarm on a coin and spends one alarm slot from the key owner's balance. The target is checked against the coin's current value so the alarm cannot self-trigger instantly: an above alarm must target more than the current value, a below alarm less.

post/api/v1/alarms

Request body

namestring required

A label for the alarm (max 255 characters).

coinstring required

The coin's slug identifier.

metricstring required

The watched metric: rate, volume or marketcap.

directionstring required

Trigger direction: above or below.

targetnumber required

The threshold value (must sit on the direction side of the coin's current value).

notificationstring required

Delivery channel: email, push or webhook.

Example request

{
  "name": "BTC six figures",
  "coin": "bitcoin",
  "metric": "rate",
  "direction": "above",
  "target": 100000,
  "notification": "email"
}

Response

Example response

{
  "data": {
    "id": 43,
    "name": "BTC six figures",
    "coin": {
      "slug": "bitcoin",
      "symbol": "BTC",
      "name": "Bitcoin"
    },
    "metric": "rate",
    "direction": "above",
    "target": "100000",
    "notification": "email",
    "status": "active",
    "created_at": "2026-07-03T08:00:00+00:00"
  }
}