---
title: "Asset alerts (deprecated)"
method: GET
path: "/timeseries/asset-alerts"
tags: ["Timeseries"]
---

# Asset alerts (deprecated)

`GET /timeseries/asset-alerts`

## Request

- Base URL: `https://api.coinmetrics.io/v4`
- URL: `https://api.coinmetrics.io/v4/timeseries/asset-alerts`
- Auth: API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/docs/timeseries/asset-alerts/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns asset alerts for the specified assets.<br/> This endpoint is useful for those who wants to track the breaches in the particular asset's Key Risk Indicator thresholds.<br/> An asset alert is issued once an alerting metric value either breaches it's Key Risk Indicator threshold or returns back to normal for a predefined period of time.<br/> Results are ordered by `(asset, time, alert)`.<br/> To fetch the next page of results use the `next_page_url` JSON response field.

## Query parameters

- `assets` string[], required
- `alerts` string[], required
- `start_time` string
- `end_time` string
- `start_inclusive` boolean
- `end_inclusive` boolean
- `timezone` string
- `page_size` integer
- `paging_from` 'start' | 'end', PagingFrom
- `pretty` boolean
- `format` 'json' | 'csv'
- `next_page_token` string
- `include_heartbeats` boolean

## Response `200`

Asset alerts.

- AssetAlertsResponse: Asset alerts response.
  - `heartbeats` AssetAlertHeartbeat[]
    - `asset` string, required: Name of the asset.
    - `time` string, required: The time in ISO 8601 date-time format. Always with nanoseconds precision.
    - `block_height` string: Height of the block.
    - `alert` string, required: Asset alert name.
  - `data` AssetAlert[], required
    - `asset` string, required: Name of the asset.
    - `time` string, required: The time in ISO 8601 date-time format. Always with nanoseconds precision.
    - `block_height` string: Height of the block.
    - `alert` string, required: Asset alert name.
    - `value` string: Captured value of the alerting metric. Omitted if the ratio-based alert's divisor constituent was equal to zero or if the corresponding alert rule consists of multiple conditions.
    - `threshold` string: Asset alert's Key Risk Indicator threshold value. Omitted if the corresponding alert rule consists of multiple conditions.
    - `status` string, required: Becomes 'active' if there was a breach of the Key Risk Indicator, otherwise stays 'inactive'.
  - `next_page_token` string: Token of the next page results for a given request.
  - `next_page_url` string: URL of the next page results for a given request.

## Other responses

- `400`: Asset not found.
- `401`: Requested resource requires authorization.
- `403`: Requested resource is not available with supplied credentials.
- `414`: Provided URI is too long. It must not be greater than 10000 symbols.

---

[API](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4.md) - [All operations](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/revisions/774268c0a4fe?raw)
