---
title: "POST /api/v1/monitors"
method: POST
path: "/api/v1/monitors"
tags: ["Monitors"]
---

# POST /api/v1/monitors

`POST /api/v1/monitors`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/monitors`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Creates an account monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly price is a monitor's only charge. Creation needs the credits of the first hour.

## Request body

- object
  - `username` string, required: X username to monitor, with or without @, or the account's numeric user ID. A number is a user ID. The monitor shows the username X shows for the account.
  - `name` string: Your label for the monitor. Its events carry it as monitorName. Xquik normalizes whitespace.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.

## Response `201`

Monitor created

- object
  - `id` string, required
  - `username` string, required
  - `xUserId` string, required
  - `eventTypes` EventType[], required: Array of event types to subscribe to.
  - `isActive` boolean, required
  - `createdAt` string, date-time, required
  - `nextBillingAt` string, date-time, required: Next hourly credit charge time. New active monitors are due immediately.

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `402`: Payment required. MPP reads include `WWW-Authenticate`. Authenticated reads include balances, plus checkout when the key can open it. A key that reads only gets the account page instead. A failed request never creates checkout. A caller on a plan gets top-up only, plus `credits_renew_at` when the plan renews. Guest keys offer top-up.
- `404`: X shows no profile for the account. `reason` says why. It is `not_found` for a handle or ID no account holds, which X answers for a deactivated account too, or `suspended` with the message "X suspended this account. Choose another account." when X suspended it.
- `409`: Monitor already exists
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 16 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …12 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/monitors/post.md)

---

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