---
title: "Create an alarm"
method: POST
path: "/api/v1/alarms"
tags: ["Alarms"]
---

# Create an alarm

`POST /api/v1/alarms`

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.

## Request body

- object
  - `name` string, required — A label for the alarm (max 255 characters).
  - `coin` string, required — The coin's slug identifier.
  - `metric` string, required — The watched metric: `rate`, `volume` or `marketcap`.
  - `direction` string, required — Trigger direction: `above` or `below`.
  - `target` number, required — The threshold value (must sit on the `direction` side of the coin's current value).
  - `notification` string, required — Delivery channel: `email`, `push` or `webhook`.

## Response `201`

- object
  - `data` object
    - `id` integer
    - `name` string
    - `coin` object
      - `slug` string
      - `symbol` string
      - `name` string
    - `metric` string
    - `direction` string
    - `target` string
    - `notification` string
    - `status` string
    - `created_at` string

---

[API](https://skmtc.net/bitculator/apis/bitculator-data-api.md) · [All operations](https://skmtc.net/bitculator/apis/bitculator-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitculator/bitculator-data-api/revisions/ed1378af68b6/schema)