---
title: "Create a scan alert (paid plans; Telegram else email delivery; max 25 active)"
method: POST
path: "/v1/screener/scan-alerts"
---

# Create a scan alert (paid plans; Telegram else email delivery; max 25 active)

`POST /v1/screener/scan-alerts`

## Request

- Base URL: `https://app.texttoquant.com/api`
- URL: `https://app.texttoquant.com/api/v1/screener/scan-alerts`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Request body

- object
  - `name` string, required
  - `conditions` object, required
  - `interval_minutes` integer
  - `notes` string

## Response `200`

Success

- object
  - `success` true, required
  - `data` object, required

## Other responses

- `402`: payment_required

---

[API](https://skmtc.dev/texttoquant/apis/texttoquant-api.md) · [All operations](https://skmtc.dev/texttoquant/apis/texttoquant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/texttoquant/apis/texttoquant-api/revisions/d417fc3f4a7d?raw)
